{"items":[{"type":"link","label":"Core APIs","link":"/docs/dev-docs/api","routeSlug":"/docs/dev-docs/api","content":{"contentType":"overview","meta":{"name":"Core APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/docs/dev-docs/api/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/docs/dev-docs/api/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://www.rebilly.com/contact/","url":"https://www.rebilly.com/contact/"},{"kind":"email","title":"Rebilly API Support","email":"integrations@rebilly.com","label":"integrations@rebilly.com","withCopyButton":true,"copyContent":"integrations@rebilly.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Rebilly","url":"https://www.rebilly.com/api-license/"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://www.rebilly.com/terms-of-use/"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique organization identifier."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An organization is an entity that represents a company."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain an organization ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique organization identifier."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An organization is an entity that represents a company."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain an organization ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Core APIs (latest)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/docs/dev-docs/api"}],"sectionId":"/docs/dev-docs/api"},{"nodeType":"info-metadata","rows":[{"key":"redocly_category","value":"API Reference"}]},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/introduction"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Introduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Rebilly API is built on HTTP and is RESTful."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It has predictable resource URLs and returns HTTP response codes to indicate errors."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It also accepts and returns JSON in the HTTP body."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your favorite HTTP/REST library in your programming language when using this API,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or use one of the Rebilly SDKs,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which are available in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://github.com/Rebilly/rebilly-php"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PHP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.npmjs.com/package/rebilly-js-sdk"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JavaScript"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every action in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.rebilly.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rebilly UI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported by an API which is documented and available for use, so that you may automate any necessary workflows or processes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API reference documentation contains the most commonly integrated resources."},"children":[]}]}]}]}],"sectionId":"/docs/dev-docs/api/section/introduction"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rebilly offers four forms of authentication: secret key, publishable key, JSON Web Tokens, and public signature key."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret API key: Use to make requests from the server side."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Never share these keys."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keep them guarded and secure."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Publishable API key: Use in your client-side code to tokenize payment information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT: Use to make short-life tokens that expire after a set period of time."},"children":[]}]}]}]}]}],"sectionId":"/docs/dev-docs/api/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication/manage-api-keys"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage API keys"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create or manage API keys, select one of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Rebilly UI: see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/api-keys/#manage-api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage API keys"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Rebilly API: see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key operations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information on API keys, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/concepts-and-features/concept/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/dev-docs/api/section/authentication/manage-api-keys"}],"sectionId":"/docs/dev-docs/api/section/authentication/manage-api-keys"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rebilly follows the error response format proposed in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc9457"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 9457"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which is also known as Problem Details for HTTP APIs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with any API responses, your client must be prepared to gracefully handle additional members of the response."},"children":[]}]}]}]}],"sectionId":"/docs/dev-docs/api/section/errors"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/sdks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SDKs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rebilly provides a JavaScript SDK and a PHP SDK to help interact with the Rebilly API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, no SDK is required to use the API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rebilly also provides "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/developer-docs/framepay/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FramePay"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a client-side iFrame-based solution, to help create payment tokens while minimizing PCI DSS compliance burdens"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and maximizing your customization ability."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/developer-docs/framepay/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FramePay"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" interacts with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/payment-tokens/posttoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment tokens creation operation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/dev-docs/api/section/sdks"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/sdks/javascript-sdk"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JavaScript SDK"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For installation and usage instructions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/sdks/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SDKs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All JavaScript SDK code examples are included in the API reference documentation."},"children":[]}]}]}]}],"sectionId":"/docs/dev-docs/api/section/sdks/javascript-sdk"}],"sectionId":"/docs/dev-docs/api/section/sdks/javascript-sdk"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/sdks/php-sdk"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PHP SDK"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For installation and usage instructions, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/sdks/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SDKs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All SDK code examples are included in the API reference documentation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use them, you must configure the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$client"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"$client = new Rebilly\\Client([\n 'apiKey' => 'YourApiKeyHere',\n 'baseUrl' => 'https://api.rebilly.com',\n]);\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"$client = new Rebilly\\Client([\n 'apiKey' => 'YourApiKeyHere',\n 'baseUrl' => 'https://api.rebilly.com',\n]);\n"},"children":[]}]}]}],"sectionId":"/docs/dev-docs/api/section/sdks/php-sdk"}],"sectionId":"/docs/dev-docs/api/section/sdks/php-sdk"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/get-started"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get started"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The full "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rebilly API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has over 500 operations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is likely more than you may need to implement your use cases."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you would like to implement a particular use case,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/support/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact Rebilly"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for guidance and feedback on the best API operations to use for the task."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To integrate Rebilly, and learn about related resources and concepts,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs#get-started"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get started"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create and manage API keys, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/api-keys/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/dev-docs/api/section/get-started"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/rate-limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rebilly enforces rate limits on the API to ensure that no single organization consumes too many resources."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limits are applied to the organization, and not to the API key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In sandbox environment, rate limits are enforced for non-GET endpoints and are set at 3000 requests per 10 minutes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can find the exact number of consumed requests in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-RateLimit-Limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-RateLimit-Remaining"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers in the response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the rate limit is exceeded, the API returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429 Too Many Requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-RateLimit-Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header that includes a UTC timestamp of when the rate limit resets."},"children":[]}]}]}]}],"sectionId":"/docs/dev-docs/api/section/rate-limits"}]}]}},{"type":"link","label":"Introduction","link":"/docs/dev-docs/api/section/introduction","routeSlug":"/docs/dev-docs/api/section/introduction","content":null},{"type":"group","label":"Authentication","link":"/docs/dev-docs/api/section/authentication","routeSlug":"/docs/dev-docs/api/section/authentication","items":[{"type":"link","label":"Manage API keys","link":"/docs/dev-docs/api/section/authentication/manage-api-keys","routeSlug":"/docs/dev-docs/api/section/authentication/manage-api-keys","content":null}],"content":null},{"type":"link","label":"Errors","link":"/docs/dev-docs/api/section/errors","routeSlug":"/docs/dev-docs/api/section/errors","content":null},{"type":"group","label":"SDKs","link":"/docs/dev-docs/api/section/sdks","routeSlug":"/docs/dev-docs/api/section/sdks","items":[{"type":"link","label":"JavaScript SDK","link":"/docs/dev-docs/api/section/sdks/javascript-sdk","routeSlug":"/docs/dev-docs/api/section/sdks/javascript-sdk","content":null},{"type":"link","label":"PHP SDK","link":"/docs/dev-docs/api/section/sdks/php-sdk","routeSlug":"/docs/dev-docs/api/section/sdks/php-sdk","content":null}],"content":null},{"type":"link","label":"Get started","link":"/docs/dev-docs/api/section/get-started","routeSlug":"/docs/dev-docs/api/section/get-started","content":null},{"type":"link","label":"Rate limits","link":"/docs/dev-docs/api/section/rate-limits","routeSlug":"/docs/dev-docs/api/section/rate-limits","content":null},{"type":"separator","label":"Customers","content":null},{"type":"group","label":"Customers","link":"/docs/dev-docs/api/customers","routeSlug":"/docs/dev-docs/api/customers","items":[{"label":"Retrieve customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/getcustomercollection","routeSlug":"/docs/dev-docs/api/customers/getcustomercollection","metadata":{"seo":{"title":"Retrieve customers","description":"Retrieves a list of customers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCustomerCollection","name":"Retrieve customers","isWebhook":false,"pointer":"/paths/~1customers/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve customers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of customers."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."},{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"fields","in":"query","schemaId":"schema_782","description":"Limits the returned fields to the specified list, each field separated by a comma.\nThe ID value is always returned."},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1customers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"q","in":"query","schemaId":"schema_782"},{"name":"expand","in":"query","schemaId":"schema_782"},{"name":"fields","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/customers","href":"customers/getcustomercollection","openApiOperationId":"GetCustomerCollection","summary":"Retrieve customers","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$customers = $client->customers()->search([\n 'filter' => 'firstName:John',\n]);\n"},{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.customers.getAll();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100, sort: '-createdTime'};\nconst secondCollection = await api.customers.getAll(params);\n\n// access the collection items, each item is a Customer\nsecondCollection.items.forEach(customer => console.log(customer.fields.primaryAddress.firstName));\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$customersPaginator = $service->customers()->getAllPaginator(limit: 5);\nforeach ($customersPaginator as $customerPage) {\n printf(\"Customers page %d/%d\\n\", $customersPaginator->key() + 1, $customersPaginator->count());\n foreach ($customerPage as $customer) {\n printf(\"Customer #%s: %s\\n\", $customer->getId(), $customer->getFirstName());\n }\n}\n\n// OR\n\n$customers = $service->customers()->getAll(filter: 'firstName:John');\nforeach ($customers as $customer) {\n printf(\"Customer #%s: %s\\n\", $customer->getId(), $customer->getFirstName());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of customers retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_784"}},"schemaId":"schema_784","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1customers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_784","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_784"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/getcustomercollection"}],"panels":[]}]},"httpPath":"/customers"},{"label":"Create a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/postcustomer","routeSlug":"/docs/dev-docs/api/customers/postcustomer","metadata":{"seo":{"title":"Create a customer","description":"Creates a new customer and customer ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostCustomer","name":"Create a customer","isWebhook":false,"pointer":"/paths/~1customers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new customer and customer ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer's primary address is used as the default address for payment instruments,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptions, and invoices if none are provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the customer already has an identifier within your system,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and you want to create customer with a predefined ID —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to prevent duplicate customers, use the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upsert a customer with predefined ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/dev-docs/customers#prevent-duplicate-customers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prevent duplicate customers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Customer"}},"schemaId":"components/schemas/Customer","pointer":"/paths/~1customers/post/requestBody","description":"Customer resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Customer"}},"responseCodes":["201","401","403","409","422","429"],"pointer":"/customers","href":"customers/postcustomer","openApiOperationId":"PostCustomer","summary":"Create a customer","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$customerForm = new Rebilly\\Entities\\Customer();\n$customerForm->setPrimaryAddress([\n 'firstName' => 'John',\n 'lastName' => 'Doe',\n 'organization' => 'Test LTD',\n 'address' => 'Test street 5',\n 'address2' => 'Test house 5',\n 'city' => 'New York',\n 'region' => 'Long Island',\n 'country' => 'US',\n 'postalCode' => '123456',\n 'emails' => [\n [\n 'label' => 'main',\n 'value' => 'johndoe@testemail.com',\n 'primary' => true,\n ],\n [\n 'label' => 'secondary',\n 'value' => 'otheremail@testemail.com',\n ],\n ],\n 'phoneNumbers' => [\n [\n 'label' => 'work',\n 'value' => '+123456789',\n 'primary' => true,\n ],\n [\n 'label' => 'home',\n 'value' => '+9874654321',\n ],\n ],\n]);\n\ntry {\n $customer = $client->customers()->create($customerForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the properties for the new customer\nconst data = {\n primaryAddress: {\n firstName: 'John',\n lastName: 'Doe',\n emails: [{\n label: 'main',\n value: 'john.doe+test@grr.la',\n primary: true\n }],\n }\n};\n\n// the ID is optional\nconst firstCustomer = await api.customers.create({data});\n\n// or you can provide one\nconst secondCustomer = await api.customers.create({id: 'my-second-id', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$customerForm = \\Rebilly\\Sdk\\Model\\Customer::from([])\n ->setWebsiteId('websiteId')\n ->setPrimaryAddress(\n \\Rebilly\\Sdk\\Model\\ContactObject::from([])\n ->setFirstName('John')\n ->setLastName('Doe')\n ->setAddress('Test street 5')\n ->setEmails([\n \\Rebilly\\Sdk\\Model\\ContactEmails::from([])\n ->setLabel('main')\n ->setValue('johndoe@email.com')\n ->setPrimary(true),\n ]),\n );\n\ntry {\n $customer = $service->customers()->create($customerForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Customer","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Customer"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Customer created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer"}},"schemaId":"components/schemas/Customer","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1customers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Customer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/postcustomer"}],"panels":[]}]},"httpPath":"/customers"},{"label":"Retrieve a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/getcustomer","routeSlug":"/docs/dev-docs/api/customers/getcustomer","metadata":{"seo":{"title":"Retrieve a customer","description":"Retrieves a customer with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCustomer","name":"Retrieve a customer","isWebhook":false,"pointer":"/paths/~1customers~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a customer with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1customers~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"fields","in":"query","schemaId":"schema_782","description":"Limits the returned fields to the specified list, each field separated by a comma.\nThe ID value is always returned."}],"pointer":"/paths/~1customers~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"expand","in":"query","schemaId":"schema_782"},{"name":"fields","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/customers/{id}","href":"customers/getcustomer","openApiOperationId":"GetCustomer","summary":"Retrieve a customer","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$customers = $client->customers()->load('myCustomerId');\n"},{"lang":"JavaScript","source":"const customer = await api.customers.get({id: 'foobar-001'});\nconsole.log(customer.fields.primaryAddress.firstName);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$customer = $service->customers()->get('customerId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Customer retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer"}},"schemaId":"components/schemas/Customer"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1customers~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Customer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/getcustomer"}],"panels":[]}]},"httpPath":"/customers/{id}"},{"label":"Upsert a customer","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/putcustomer","routeSlug":"/docs/dev-docs/api/customers/putcustomer","metadata":{"seo":{"title":"Upsert a customer","description":"Creates or updates (upserts) a customer with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutCustomer","name":"Upsert a customer","isWebhook":false,"pointer":"/paths/~1customers~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates or updates (upserts) a customer with a specified ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the customer already has an identifier within your system,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and you want to create a customer with a specified ID — use this operation to prevent duplicate customers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/customers#prevent-duplicate-customers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prevent duplicate customers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1customers~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Customer"}},"schemaId":"components/schemas/Customer","pointer":"/paths/~1customers~1{id}/put/requestBody","description":"Customer resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/customers/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Customer"}},"responseCodes":["200","201","401","403","409","422","429"],"pointer":"/customers/{id}","href":"customers/putcustomer","openApiOperationId":"PutCustomer","summary":"Upsert a customer","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$customerForm = new Rebilly\\Entities\\Customer();\n$customerForm->setPrimaryAddress([\n 'firstName' => 'John',\n 'lastName' => 'Doe',\n 'organization' => 'Test LTD',\n 'address' => 'Test street 5',\n 'address2' => 'Test house 5',\n 'city' => 'New York',\n 'region' => 'Long Island',\n 'country' => 'US',\n 'postalCode' => '123456',\n 'emails' => [\n [\n 'label' => 'main',\n 'value' => 'johndoe@testemail.com',\n 'primary' => true,\n ],\n [\n 'label' => 'secondary',\n 'value' => 'otheremail@testemail.com',\n ],\n ],\n 'phoneNumbers' => [\n [\n 'label' => 'work',\n 'value' => '+123456789',\n 'primary' => true,\n ],\n [\n 'label' => 'home',\n 'value' => '+9874654321',\n ],\n ],\n]);\n\ntry {\n $customer = $client->customers()->update('myCustomerId', $customerForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// creating a customer\nconst data = {\n primaryAddress: {\n firstName: 'John',\n lastName: 'Doe',\n emails: [{\n label: 'main',\n value: 'john.doe+test@grr.la',\n primary: true\n }],\n }\n};\n\n// the ID is optional\nconst firstCustomer = await api.customers.create({data});\n\n// or you can provide one\nconst secondCustomer = await api.customers.create({id: 'my-second-id', data});\n\n\n\n// updating a customer\nconst data = {\n primaryAddress: {\n firstName: 'Johnny',\n lastName: 'Doe',\n emails: [{\n label: 'main',\n value: 'johnny.doe+test@grr.la',\n primary: true\n }],\n }\n};\n\nconst customer = await api.customers.update({id: 'my-second-id', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$customerForm = \\Rebilly\\Sdk\\Model\\Customer::from([])\n ->setWebsiteId('websiteId')\n ->setPrimaryAddress(\n \\Rebilly\\Sdk\\Model\\ContactObject::from([])\n ->setFirstName('John')\n ->setLastName('Doe')\n ->setAddress('Test street 5')\n ->setEmails([\n \\Rebilly\\Sdk\\Model\\ContactEmails::from([])\n ->setLabel('main')\n ->setValue('johndoe@email.com')\n ->setPrimary(true),\n ]),\n );\n\ntry {\n $customer = $service->customers()->update('myCustomerId', $customerForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Customer","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Customer"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Customer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer"}},"schemaId":"components/schemas/Customer"},{"code":"201","description":"Customer with a specified ID created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer"}},"schemaId":"components/schemas/Customer","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1customers~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Customer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer"}}},{"code":"201","schemaId":"components/schemas/Customer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/putcustomer"}],"panels":[]}]},"httpPath":"/customers/{id}"},{"label":"Merge and delete a customer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/deletecustomer","routeSlug":"/docs/dev-docs/api/customers/deletecustomer","metadata":{"seo":{"title":"Merge and delete a customer","description":"Merges one duplicate customer to another target customer and deletes the former."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteCustomer","name":"Merge and delete a customer","isWebhook":false,"pointer":"/paths/~1customers~1{id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge and delete a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Merges one duplicate customer to another target customer and deletes the former."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1customers~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"targetCustomerId","in":"query","schemaId":"schema_782","description":"ID of the customer that you want to delete. This field is used\nto obtain the customer's data.","required":true}],"pointer":"/paths/~1customers~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/customers/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"targetCustomerId","in":"query","required":true,"schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","429"],"pointer":"/customers/{id}","href":"customers/deletecustomer","openApiOperationId":"DeleteCustomer","summary":"Merge and delete a customer","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$service->customers()->merge('customerId', 'targetCustomerId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Customer is merged and deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1customers~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/deletecustomer"}],"panels":[]}]},"httpPath":"/customers/{id}"},{"label":"Retrieve a customer's lead source","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/getcustomerleadsource","routeSlug":"/docs/dev-docs/api/customers/getcustomerleadsource","metadata":{"seo":{"title":"Retrieve a customer's lead source","description":"Retrieves lead source data for a customer with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCustomerLeadSource","name":"Retrieve a customer's lead source","isWebhook":false,"pointer":"/paths/~1customers~1{id}~1lead-source/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a customer's lead source","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves lead source data for a customer with a specified ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A lead source is the marketing campaign that generates customer interaction, a sale, or a trial."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/customers/#lead-source-attribution"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lead source attribution"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1customers~1{id}~1lead-source/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{id}/lead-source","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/customers/{id}/lead-source","href":"customers/getcustomerleadsource","openApiOperationId":"GetCustomerLeadSource","summary":"Retrieve a customer's lead source","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$customer = $client->customers()->load('myCustomerId');\n$leadSource = $customer->getLeadSource();\n"},{"lang":"JavaScript","source":"const lead = await api.customers.getLeadSource({id: 'my-second-id'});\nconsole.log(lead.fields.affiliate);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$customerLeadSource = $service->customers()->getLeadSource('customerId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Lead source retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LeadSource"}},"schemaId":"components/schemas/LeadSource"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1customers~1{id}~1lead-source/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LeadSource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LeadSource"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/getcustomerleadsource"}],"panels":[]}]},"httpPath":"/customers/{id}/lead-source"},{"label":"Create a customer's lead source","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/putcustomerleadsource","routeSlug":"/docs/dev-docs/api/customers/putcustomerleadsource","metadata":{"seo":{"title":"Create a customer's lead source","description":"Creates a lead source for a customer with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutCustomerLeadSource","name":"Create a customer's lead source","isWebhook":false,"pointer":"/paths/~1customers~1{id}~1lead-source/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a customer's lead source","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a lead source for a customer with a specified ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A lead source is the marketing campaign that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generates customer interaction, a sale, or a trial."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/dev-docs/lead-source-attribution"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lead source attribution"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1customers~1{id}~1lead-source/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LeadSource"}},"schemaId":"components/schemas/LeadSource","pointer":"/paths/~1customers~1{id}~1lead-source/put/requestBody","description":"Lead Source resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/customers/{id}/lead-source","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LeadSource"}},"responseCodes":["201","401","403","422","429"],"pointer":"/customers/{id}/lead-source","href":"customers/putcustomerleadsource","openApiOperationId":"PutCustomerLeadSource","summary":"Create a customer's lead source","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$leadSourceForm = new Rebilly\\Entities\\LeadSource();\n$leadSourceForm->setSource('TestSource');\n$leadSourceForm->setCampaign('TestCampaign');\n\ntry {\n $customer = $client->customers()->updateLeadSource('myCustomerId', $leadSourceForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the properties for the new lead source\nconst data = {\n medium: 'foobar',\n source: 'www.google.com',\n campaign: 'my-first-campaign',\n term: 'subscriptions',\n content: 'subscription business',\n affiliate: 'Acme',\n subAffiliate: null,\n salesAgent: null,\n clickId: null,\n path: null,\n ipAddress: '12.34.56.78',\n currency: 'USD',\n amount: 0\n};\n\nconst lead = await api.customers.createLeadSource({id: 'my-second-id', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$leadSourceForm = \\Rebilly\\Sdk\\Model\\LeadSource::from([])\n ->setSource('TestSource')\n ->setCampaign('TestCampaign');\n\ntry {\n $customer = $service->customers()->createLeadSource('myCustomerId', $leadSourceForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/LeadSource","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LeadSource"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Lead source created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LeadSource"}},"schemaId":"components/schemas/LeadSource","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1customers~1{id}~1lead-source/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/LeadSource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LeadSource"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/putcustomerleadsource"}],"panels":[]}]},"httpPath":"/customers/{id}/lead-source"},{"label":"Delete a customer's lead source","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/deletecustomerleadsource","routeSlug":"/docs/dev-docs/api/customers/deletecustomerleadsource","metadata":{"seo":{"title":"Delete a customer's lead source","description":"Deletes lead source data for a customer with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteCustomerLeadSource","name":"Delete a customer's lead source","isWebhook":false,"pointer":"/paths/~1customers~1{id}~1lead-source/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a customer's lead source","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes lead source data for a customer with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1customers~1{id}~1lead-source/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/customers/{id}/lead-source","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","409","429"],"pointer":"/customers/{id}/lead-source","href":"customers/deletecustomerleadsource","openApiOperationId":"DeleteCustomerLeadSource","summary":"Delete a customer's lead source","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$client->customers()->deleteLeadSource('myCustomerId');\n"},{"lang":"JavaScript","source":"const request = await api.customers.deleteLeadSource({id: 'my-second-id'});\n\n// the request does not return any fields but\n// you can confirm the success using the status code\nconsole.log(request.response.status); // 204"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$service->customers()->deleteLeadSource('customerId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Lead source deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1customers~1{id}~1lead-source/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/deletecustomerleadsource"}],"panels":[]}]},"httpPath":"/customers/{id}/lead-source"},{"label":"Retrieve customer credit balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/getcustomercreditbalance","routeSlug":"/docs/dev-docs/api/customers/getcustomercreditbalance","metadata":{"seo":{"title":"Retrieve customer credit balance","description":"Retrieves a customer's credit balance grouped by currency."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCustomerCreditBalance","name":"Retrieve customer credit balance","isWebhook":false,"pointer":"/paths/~1customers~1{id}~1credit-balance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve customer credit balance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a customer's credit balance grouped by currency."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1customers~1{id}~1credit-balance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{id}/credit-balance","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/customers/{id}/credit-balance","href":"customers/getcustomercreditbalance","openApiOperationId":"GetCustomerCreditBalance","summary":"Retrieve customer credit balance","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Customer credit balance retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerCreditBalance"}},"schemaId":"components/schemas/CustomerCreditBalance"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1customers~1{id}~1credit-balance/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerCreditBalance","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerCreditBalance"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/getcustomercreditbalance"}],"panels":[]}]},"httpPath":"/customers/{id}/credit-balance"},{"label":"Create a compliance screening report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers/postcustomercompliancescreeningreport","routeSlug":"/docs/dev-docs/api/customers/postcustomercompliancescreeningreport","metadata":{"seo":{"title":"Create a compliance screening report","description":"Creates a compliance screening report that includes Know Your Customer (KYC) and Anti-Money Laundering (AML) results for a customer. The report is stored as a PDF customer attachment. Requires the KYC and AML products to be enabled for the organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostCustomerComplianceScreeningReport","name":"Create a compliance screening report","isWebhook":false,"pointer":"/paths/~1customers~1{id}~1compliance-screening-report/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a compliance screening report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a compliance screening report that includes Know Your Customer (KYC) and Anti-Money Laundering (AML) results for a customer.\nThe report is stored as a PDF customer attachment.\nRequires the KYC and AML products to be enabled for the organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1customers~1{id}~1compliance-screening-report/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers/{id}/compliance-screening-report","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","401","403","404","429"],"pointer":"/customers/{id}/compliance-screening-report","href":"customers/postcustomercompliancescreeningreport","openApiOperationId":"PostCustomerComplianceScreeningReport","summary":"Create a compliance screening report","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Compliance screening report generated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Attachment"}},"schemaId":"components/schemas/Attachment","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1customers~1{id}~1compliance-screening-report/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Attachment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Attachment"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/postcustomercompliancescreeningreport"}],"panels":[]}]},"httpPath":"/customers/{id}/compliance-screening-report"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Customer created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/customers/customer-created","routeSlug":"/docs/dev-docs/api/customers/customer-created","metadata":{"seo":{"title":"Customer created","description":"Customer created"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customer-created","name":"Customer created","isWebhook":true,"pointer":"/paths/customer-created/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer created","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_790"}},"schemaId":"schema_790","pointer":"/paths/customer-created/post/requestBody","description":"Payload of customer-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"customer-created","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_790"}},"responseCodes":["2xx"],"pointer":"customer-created","href":"customers/customer-created","openApiOperationId":"customer-created","summary":"Customer created","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_790","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_790"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/customer-created/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/customer-created"}],"panels":[]}]},"httpPath":"customer-created"},{"label":"Customer merged","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/customers/customer-merged","routeSlug":"/docs/dev-docs/api/customers/customer-merged","metadata":{"seo":{"title":"Customer merged","description":"Customer merged"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customer-merged","name":"Customer merged","isWebhook":true,"pointer":"/paths/customer-merged/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer merged","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_791"}},"schemaId":"schema_791","pointer":"/paths/customer-merged/post/requestBody","description":"Payload of customer merge-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"customer-merged","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_791"}},"responseCodes":["2xx"],"pointer":"customer-merged","href":"customers/customer-merged","openApiOperationId":"customer-merged","summary":"Customer merged","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_791","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_791"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/customer-merged/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/customer-merged"}],"panels":[]}]},"httpPath":"customer-merged"},{"label":"Customer one-time-password requested","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/customers/customer-one-time-password-requested","routeSlug":"/docs/dev-docs/api/customers/customer-one-time-password-requested","metadata":{"seo":{"title":"Customer one-time-password requested","description":"Customer one-time-password requested"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customer-one-time-password-requested","name":"Customer one-time-password requested","isWebhook":true,"pointer":"/paths/customer-one-time-password-requested/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer one-time-password requested","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_790"}},"schemaId":"schema_790","pointer":"/paths/customer-one-time-password-requested/post/requestBody","description":"Payload of customer-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"customer-one-time-password-requested","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_790"}},"responseCodes":["2xx"],"pointer":"customer-one-time-password-requested","href":"customers/customer-one-time-password-requested","openApiOperationId":"customer-one-time-password-requested","summary":"Customer one-time-password requested","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_790","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_790"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/customer-one-time-password-requested/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/customer-one-time-password-requested"}],"panels":[]}]},"httpPath":"customer-one-time-password-requested"},{"label":"Customer tax number validated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/customers/customer-tax-number-validated","routeSlug":"/docs/dev-docs/api/customers/customer-tax-number-validated","metadata":{"seo":{"title":"Customer tax number validated","description":"Customer tax number validated"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customer-tax-number-validated","name":"Customer tax number validated","isWebhook":true,"pointer":"/paths/customer-tax-number-validated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer tax number validated","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_792"}},"schemaId":"schema_792","pointer":"/paths/customer-tax-number-validated/post/requestBody","description":"Payload of customer tax number validation-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"customer-tax-number-validated","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_792"}},"responseCodes":["2xx"],"pointer":"customer-tax-number-validated","href":"customers/customer-tax-number-validated","openApiOperationId":"customer-tax-number-validated","summary":"Customer tax number validated","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_792","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_792"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/customer-tax-number-validated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/customer-tax-number-validated"}],"panels":[]}]},"httpPath":"customer-tax-number-validated"},{"label":"Customer updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/customers/customer-updated","routeSlug":"/docs/dev-docs/api/customers/customer-updated","metadata":{"seo":{"title":"Customer updated","description":"Customer updated"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customer-updated","name":"Customer updated","isWebhook":true,"pointer":"/paths/customer-updated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer updated","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_790"}},"schemaId":"schema_790","pointer":"/paths/customer-updated/post/requestBody","description":"Payload of customer-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"customer-updated","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_790"}},"responseCodes":["2xx"],"pointer":"customer-updated","href":"customers/customer-updated","openApiOperationId":"customer-updated","summary":"Customer updated","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_790","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_790"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/customer-updated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/customer-updated"}],"panels":[]}]},"httpPath":"customer-updated"},{"label":"Experian check performed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/customers/experian-check-performed","routeSlug":"/docs/dev-docs/api/customers/experian-check-performed","metadata":{"seo":{"title":"Experian check performed","description":"Experian check performed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"experian-check-performed","name":"Experian check performed","isWebhook":true,"pointer":"/paths/experian-check-performed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Experian check performed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_793"}},"schemaId":"schema_793","pointer":"/paths/experian-check-performed/post/requestBody","description":"Payload of Experian check-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"experian-check-performed","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_793"}},"responseCodes":["2xx"],"pointer":"experian-check-performed","href":"customers/experian-check-performed","openApiOperationId":"experian-check-performed","summary":"Experian check performed","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_793","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_793"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/experian-check-performed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/experian-check-performed"}],"panels":[]}]},"httpPath":"experian-check-performed"},{"label":"Lead source changed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/customers/lead-source-changed","routeSlug":"/docs/dev-docs/api/customers/lead-source-changed","metadata":{"seo":{"title":"Lead source changed","description":"Lead source changed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"lead-source-changed","name":"Lead source changed","isWebhook":true,"pointer":"/paths/lead-source-changed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lead source changed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_790"}},"schemaId":"schema_790","pointer":"/paths/lead-source-changed/post/requestBody","description":"Payload of customer-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"lead-source-changed","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_790"}},"responseCodes":["2xx"],"pointer":"lead-source-changed","href":"customers/lead-source-changed","openApiOperationId":"lead-source-changed","summary":"Lead source changed","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_790","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_790"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/lead-source-changed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/lead-source-changed"}],"panels":[]}]},"httpPath":"lead-source-changed"}],"content":{"contentType":"group","meta":{"name":"Customers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customers","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these operations to manage customers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A customer is an entity that purchases goods or services from you (a merchant),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and is the payee in any transaction that is credited to you."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers are associated with payment instruments,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptions, invoices, and other related resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In other systems, customers may be referred to as accounts,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"clients, members, patrons, or players."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For information on the customer resource, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/concepts/#resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customers","summary":"Retrieve customers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/getcustomercollection","deprecated":false},{"title":"/customers","summary":"Create a customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/postcustomer","deprecated":false},{"title":"/customers/{id}","summary":"Retrieve a customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/getcustomer","deprecated":false},{"title":"/customers/{id}","summary":"Upsert a customer","prefix":{"name":"put","color":"put"},"badges":[],"link":"/customers/putcustomer","deprecated":false},{"title":"/customers/{id}","summary":"Merge and delete a customer","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/customers/deletecustomer","deprecated":false},{"title":"/customers/{id}/lead-source","summary":"Retrieve a customer's lead source","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/getcustomerleadsource","deprecated":false},{"title":"/customers/{id}/lead-source","summary":"Create a customer's lead source","prefix":{"name":"put","color":"put"},"badges":[],"link":"/customers/putcustomerleadsource","deprecated":false},{"title":"/customers/{id}/lead-source","summary":"Delete a customer's lead source","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/customers/deletecustomerleadsource","deprecated":false},{"title":"/customers/{id}/credit-balance","summary":"Retrieve customer credit balance","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/getcustomercreditbalance","deprecated":false},{"title":"/customers/{id}/compliance-screening-report","summary":"Create a compliance screening report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/postcustomercompliancescreeningreport","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"customer-created","summary":"Customer created","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/customer-created","deprecated":false},{"title":"customer-merged","summary":"Customer merged","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/customer-merged","deprecated":false},{"title":"customer-one-time-password-requested","summary":"Customer one-time-password requested","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/customer-one-time-password-requested","deprecated":false},{"title":"customer-tax-number-validated","summary":"Customer tax number validated","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/customer-tax-number-validated","deprecated":false},{"title":"customer-updated","summary":"Customer updated","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/customer-updated","deprecated":false},{"title":"experian-check-performed","summary":"Experian check performed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/experian-check-performed","deprecated":false},{"title":"lead-source-changed","summary":"Lead source changed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/lead-source-changed","deprecated":false}]}]}]}]}},{"type":"group","label":"Customer authentication","link":"/docs/dev-docs/api/customer-authentication","routeSlug":"/docs/dev-docs/api/customer-authentication","items":[{"label":"Retrieve authentication options","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/getauthenticationoption","routeSlug":"/docs/dev-docs/api/customer-authentication/getauthenticationoption","metadata":{"seo":{"title":"Retrieve authentication options","description":"Retrieves customer authentication options."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetAuthenticationOption","name":"Retrieve authentication options","isWebhook":false,"pointer":"/paths/~1authentication-options/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve authentication options","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves customer authentication options."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authentication-options","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/authentication-options","href":"customer-authentication/getauthenticationoption","openApiOperationId":"GetAuthenticationOption","summary":"Retrieve authentication options","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$authenticationOptions = $client->authenticationOptions()->load();\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$authenticationOptions = $service->customerAuthentication()->getAuthOptions();"},{"lang":"JavaScript","source":"const options = await api.customerAuthentication.getAuthOptions();\nconsole.log(options.fields.credentialTtl);"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Authentication options retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthenticationOptions"}},"schemaId":"components/schemas/AuthenticationOptions"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1authentication-options/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuthenticationOptions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthenticationOptions"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-authentication/getauthenticationoption"}],"panels":[]}]},"httpPath":"/authentication-options"},{"label":"Change authentication options","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/putauthenticationoption","routeSlug":"/docs/dev-docs/api/customer-authentication/putauthenticationoption","metadata":{"seo":{"title":"Change authentication options","description":"Changes customer authentication options."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutAuthenticationOption","name":"Change authentication options","isWebhook":false,"pointer":"/paths/~1authentication-options/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change authentication options","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Changes customer authentication options."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuthenticationOptions"}},"schemaId":"components/schemas/AuthenticationOptions","pointer":"/paths/~1authentication-options/put/requestBody","description":"Authentication options resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/authentication-options","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuthenticationOptions"}},"responseCodes":["200","401","403","422","429"],"pointer":"/authentication-options","href":"customer-authentication/putauthenticationoption","openApiOperationId":"PutAuthenticationOption","summary":"Change authentication options","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$authenticationOptionsForm = new Rebilly\\Entities\\AuthenticationOptions();\n// Regular expression below matches any password with 6+ length that contains alphabet symbols and/or numbers.\n$authenticationOptionsForm->setPasswordPattern('/^[a-zA-Z0-9]{6,}$/');\n\ntry {\n $authenticationOptions = $client->authenticationOptions()->update($authenticationOptionsForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the properties for the authentication options\nconst data = {\n passwordPattern: null,\n credentialTtl: 10,\n authTokenTtl: 20,\n resetTokenTtl: 30\n};\n\nconst options = await api.customerAuthentication.updateAuthOptions({data});\nconsole.log(options.fields.credentialTtl);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$authenticationOptionsForm = new \\Rebilly\\Sdk\\Model\\AuthenticationOptions();\n// Regular expression below matches any password with 6+ length that contains alphabet symbols and/or numbers.\n$authenticationOptionsForm->setPasswordPattern('/^[a-zA-Z0-9]{6,}$/');\n\ntry {\n $authenticationOptions = $service->customerAuthentication()->updateAuthOptions($authenticationOptionsForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/AuthenticationOptions","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuthenticationOptions"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Authentication options updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthenticationOptions"}},"schemaId":"components/schemas/AuthenticationOptions","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1authentication-options/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuthenticationOptions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthenticationOptions"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-authentication/putauthenticationoption"}],"panels":[]}]},"httpPath":"/authentication-options"},{"label":"Retrieve authentication tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/getauthenticationtokencollection","routeSlug":"/docs/dev-docs/api/customer-authentication/getauthenticationtokencollection","metadata":{"seo":{"title":"Retrieve authentication tokens","description":"Retrieves a list of customer authentication tokens."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetAuthenticationTokenCollection","name":"Retrieve authentication tokens","isWebhook":false,"pointer":"/paths/~1authentication-tokens/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve authentication tokens","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of customer authentication tokens."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."}],"pointer":"/paths/~1authentication-tokens/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authentication-tokens","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/authentication-tokens","href":"customer-authentication/getauthenticationtokencollection","openApiOperationId":"GetAuthenticationTokenCollection","summary":"Retrieve authentication tokens","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$authenticationTokens = $client->authenticationTokens()->search([\n 'filter' => 'customerId:testCustomer',\n]);\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$listOfTokens = $service->customerAuthentication()->getAllAuthTokens();\n\n// alternatively you can specify one or more of them\n$listOfTokens = $coreService->customerAuthentication()->getAllAuthTokens(limit: 5, offset: 2);"},{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.customerAuthentication.getAllAuthTokens();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100};\nconst secondCollection = await api.customerAuthentication.getAllAuthTokens(params);\n\n// access the collection items, each item is an AuthenticationToken\nsecondCollection.items.forEach(token => console.log(token.fields.username));\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of auth tokens retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_794"}},"schemaId":"schema_794","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1authentication-tokens/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_794","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_794"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-authentication/getauthenticationtokencollection"}],"panels":[]}]},"httpPath":"/authentication-tokens"},{"label":"Login a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/postauthenticationtoken","routeSlug":"/docs/dev-docs/api/customer-authentication/postauthenticationtoken","metadata":{"seo":{"title":"Login a customer","description":"Logs in a customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostAuthenticationToken","name":"Login a customer","isWebhook":false,"pointer":"/paths/~1authentication-tokens/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Login a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Logs in a customer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"PublishableApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This authentication method is applicable to specific operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a publishable API key, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/api-keys/postapikey"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an API key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuthenticationToken"}},"schemaId":"components/schemas/AuthenticationToken","pointer":"/paths/~1authentication-tokens/post/requestBody","description":"AuthenticationToken resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/authentication-tokens","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PublishableApiKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuthenticationToken"}},"responseCodes":["201","401","403","422","429"],"pointer":"/authentication-tokens","href":"customer-authentication/postauthenticationtoken","openApiOperationId":"PostAuthenticationToken","summary":"Login a customer","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"PublishableApiKey":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$authenticationForm = new Rebilly\\Entities\\AuthenticationToken();\n$authenticationForm->setUsername('username');\n$authenticationForm->setPassword('test123');\n\ntry {\n $authenticationToken = $client->authenticationTokens()->login($authenticationForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"const data = {\n username: 'foobar',\n password: 'fuubar'\n\n // optionally you can define an `expiredTime` to \n // limit the duration of the session token\n\n //expiredTime: '2017-09-18T19:17:39Z'\n};\nconst session = await api.customerAuthentication.login({data});\nconsole.log(session.fields.token);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$authenticationForm = \\Rebilly\\Sdk\\Model\\AuthenticationTokenPasswordMode::from();\n$authenticationForm->setUsername('username');\n$authenticationForm->setPassword('test123');\n\ntry {\n $authenticationToken = $service->customerAuthentication()->login($authenticationForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/AuthenticationToken","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuthenticationToken"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Login successful.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthenticationTokenResponse"}},"schemaId":"components/schemas/AuthenticationTokenResponse","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1authentication-tokens/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/AuthenticationTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthenticationTokenResponse"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-authentication/postauthenticationtoken"}],"panels":[]}]},"httpPath":"/authentication-tokens"},{"label":"Verify an authentication token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/getauthenticationtokenverification","routeSlug":"/docs/dev-docs/api/customer-authentication/getauthenticationtokenverification","metadata":{"seo":{"title":"Verify an authentication token","description":"Verifies a customer's authentication token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetAuthenticationTokenVerification","name":"Verify an authentication token","isWebhook":false,"pointer":"/paths/~1authentication-tokens~1{token}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify an authentication token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Verifies a customer's authentication token."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"PublishableApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This authentication method is applicable to specific operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a publishable API key, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/api-keys/postapikey"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an API key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token","in":"path","schemaId":"schema_782","description":"ID of the authentication token.","required":true}],"pointer":"/paths/~1authentication-tokens~1{token}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authentication-tokens/{token}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"token","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PublishableApiKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/authentication-tokens/{token}","href":"customer-authentication/getauthenticationtokenverification","openApiOperationId":"GetAuthenticationTokenVerification","summary":"Verify an authentication token","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"PublishableApiKey":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$isVerified = $client->authenticationTokens()->verify('token');\n"},{"lang":"JavaScript","source":"const token = 'dcf6e32f2daee457a1db8ce5fdfbe200';\nconst verification = await api.customerAuthentication.verify({token});\n// if the token is valid then no error will be thrown\nconsole.log(verification.reponse.status) // 200\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$isVerified = $service->customerAuthentication()->verify('token');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Authentication token verified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthenticationTokenResponse"}},"schemaId":"components/schemas/AuthenticationTokenResponse"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1authentication-tokens~1{token}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuthenticationTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthenticationTokenResponse"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-authentication/getauthenticationtokenverification"}],"panels":[]}]},"httpPath":"/authentication-tokens/{token}"},{"label":"Logout a customer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/deleteauthenticationtoken","routeSlug":"/docs/dev-docs/api/customer-authentication/deleteauthenticationtoken","metadata":{"seo":{"title":"Logout a customer","description":"Logs out a customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteAuthenticationToken","name":"Logout a customer","isWebhook":false,"pointer":"/paths/~1authentication-tokens~1{token}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Logout a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Logs out a customer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"PublishableApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This authentication method is applicable to specific operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a publishable API key, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/api-keys/postapikey"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an API key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token","in":"path","schemaId":"schema_782","description":"ID of the authentication token.","required":true}],"pointer":"/paths/~1authentication-tokens~1{token}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/authentication-tokens/{token}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"token","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PublishableApiKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","404","429"],"pointer":"/authentication-tokens/{token}","href":"customer-authentication/deleteauthenticationtoken","openApiOperationId":"DeleteAuthenticationToken","summary":"Logout a customer","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"PublishableApiKey":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$client->authenticationTokens()->logout('token');\n"},{"lang":"JavaScript","source":"const token = 'dcf6e32f2daee457a1db8ce5fdfbe200';\nconst request = await api.customerAuthentication.logout({token});\n\n// the request does not return any fields but\n// you can confirm the success using the status code\nconsole.log(request.response.status); // 204"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$service->customerAuthentication()->logout('token');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Customer logged out.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1authentication-tokens~1{token}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-authentication/deleteauthenticationtoken"}],"panels":[]}]},"httpPath":"/authentication-tokens/{token}"},{"label":"Exchange an authentication token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/postauthenticationtokenexchange","routeSlug":"/docs/dev-docs/api/customer-authentication/postauthenticationtokenexchange","metadata":{"seo":{"title":"Exchange an authentication token","description":"Exchanges an authentication token for a JWT."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostAuthenticationTokenExchange","name":"Exchange an authentication token","isWebhook":false,"pointer":"/paths/~1authentication-tokens~1{token}~1exchange/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exchange an authentication token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Exchanges an authentication token for a JWT.\n\n\nBy default, this operation invalidates the exchanged authentication token."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"PublishableApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This authentication method is applicable to specific operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a publishable API key, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/api-keys/postapikey"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an API key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token","in":"path","schemaId":"schema_782","description":"ID of the authentication token.","required":true}],"pointer":"/paths/~1authentication-tokens~1{token}~1exchange/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerJWT"}},"schemaId":"components/schemas/CustomerJWT","pointer":"/paths/~1authentication-tokens~1{token}~1exchange/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/authentication-tokens/{token}/exchange","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"token","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PublishableApiKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomerJWT"}},"responseCodes":["201","401","403","404","429"],"pointer":"/authentication-tokens/{token}/exchange","href":"customer-authentication/postauthenticationtokenexchange","openApiOperationId":"PostAuthenticationTokenExchange","summary":"Exchange an authentication token","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"PublishableApiKey":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/CustomerJWT","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerJWT"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Authentication token exchanged for a JWT.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerJWT"}},"schemaId":"components/schemas/CustomerJWT","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1authentication-tokens~1{token}~1exchange/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CustomerJWT","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerJWT"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-authentication/postauthenticationtokenexchange"}],"panels":[]}]},"httpPath":"/authentication-tokens/{token}/exchange"},{"label":"Retrieve credentials","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/getcredentialcollection","routeSlug":"/docs/dev-docs/api/customer-authentication/getcredentialcollection","metadata":{"seo":{"title":"Retrieve credentials","description":"Retrieves a list of authentication credentials."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCredentialCollection","name":"Retrieve credentials","isWebhook":false,"pointer":"/paths/~1credentials/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve credentials","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of authentication credentials."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."}],"pointer":"/paths/~1credentials/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credentials","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/credentials","href":"customer-authentication/getcredentialcollection","openApiOperationId":"GetCredentialCollection","summary":"Retrieve credentials","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$customerCredentials = $client->customerCredentials()->search([\n 'filter' => 'customerId:testCustomer',\n]);\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$customerCredentials = $service->customerAuthentication()->getAllCredentials(limit: 10);"},{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.customerAuthentication.getAllCredentials();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100};\nconst secondCollection = await api.customerAuthentication.getAllCredentials(params);\n\n// access the collection items, each item is a CustomerCredential\nsecondCollection.items.forEach(credential => console.log(credential.fields.customerId));\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of authentication credentials retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_795"}},"schemaId":"schema_795","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1credentials/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_795","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_795"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-authentication/getcredentialcollection"}],"panels":[]}]},"httpPath":"/credentials"},{"label":"Create a credential","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/postcredential","routeSlug":"/docs/dev-docs/api/customer-authentication/postcredential","metadata":{"seo":{"title":"Create a credential","description":"Creates an authentication credential."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostCredential","name":"Create a credential","isWebhook":false,"pointer":"/paths/~1credentials/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an authentication credential."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerCredential"}},"schemaId":"components/schemas/CustomerCredential","pointer":"/paths/~1credentials/post/requestBody","description":"Credential resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/credentials","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomerCredential"}},"responseCodes":["201","401","403","422","429"],"pointer":"/credentials","href":"customer-authentication/postcredential","openApiOperationId":"PostCredential","summary":"Create a credential","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$customerCredentialForm = new Rebilly\\Entities\\CustomerCredential();\n$customerCredentialForm->setCustomerId('customerId');\n$customerCredentialForm->setUsername('test');\n$customerCredentialForm->setPassword('1234');\n\ntry {\n $customerCredential = $client->customerCredentials()->create($customerCredentialForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the required properties for the new credential\nconst data = {\n username: 'foobar',\n password: 'fuubar',\n customerId: 'foobar-0001'\n\n // optionally you can define an `expiredTime` to \n // limit the duration of the credential\n\n //expiredTime: '2017-09-18T19:17:39Z'\n};\n\n// the ID is optional\nconst firstCredential = await api.customerAuthentication.createCredential({data});\n\n// or you can provide one\nconst secondCredential = await api.customerAuthentication.createCredential({id: 'my-second-id', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$customerCredentialForm = \\Rebilly\\Sdk\\Model\\CustomerCredential::from([])\n ->setCustomerId('customerId')\n ->setUsername('test')\n ->setPassword('1234');\n\ntry {\n $customerCredential = $service->customerAuthentication()->createCredential($customerCredentialForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/CustomerCredential","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerCredential"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Credential created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerCredential"}},"schemaId":"components/schemas/CustomerCredential","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1credentials/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CustomerCredential","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerCredential"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-authentication/postcredential"}],"panels":[]}]},"httpPath":"/credentials"},{"label":"Retrieve a credential","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/getcredential","routeSlug":"/docs/dev-docs/api/customer-authentication/getcredential","metadata":{"seo":{"title":"Retrieve a credential","description":"Retrieves a credential with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCredential","name":"Retrieve a credential","isWebhook":false,"pointer":"/paths/~1credentials~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a credential with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1credentials~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credentials/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/credentials/{id}","href":"customer-authentication/getcredential","openApiOperationId":"GetCredential","summary":"Retrieve a credential","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$customerCredential = $client->customerCredentials()->load('credentialId');\n"},{"lang":"JavaScript","source":"const credential = await api.customerAuthentication.getCredential({id: 'my-first-id'});\nconsole.log(credential.fields.customerId);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$customerCredential = $service->customerAuthentication()->getCredential('credentialId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Credential retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerCredential"}},"schemaId":"components/schemas/CustomerCredential"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1credentials~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerCredential","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerCredential"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-authentication/getcredential"}],"panels":[]}]},"httpPath":"/credentials/{id}"},{"label":"Upsert a credential","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/putcredential","routeSlug":"/docs/dev-docs/api/customer-authentication/putcredential","metadata":{"seo":{"title":"Upsert a credential","description":"Creates or updates (upserts) an authentication credential with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutCredential","name":"Upsert a credential","isWebhook":false,"pointer":"/paths/~1credentials~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates (upserts) an authentication credential with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1credentials~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerCredential"}},"schemaId":"components/schemas/CustomerCredential","pointer":"/paths/~1credentials~1{id}/put/requestBody","description":"Credential resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/credentials/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomerCredential"}},"responseCodes":["200","201","401","403","404","422","429"],"pointer":"/credentials/{id}","href":"customer-authentication/putcredential","openApiOperationId":"PutCredential","summary":"Upsert a credential","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$customerCredentialForm = new Rebilly\\Entities\\CustomerCredential();\n$customerCredentialForm->setCustomerId('customerId');\n$customerCredentialForm->setUsername('test');\n$customerCredentialForm->setPassword('1234');\n\ntry {\n $customerCredential = $client->customerCredentials()->update('credentialId', $customerCredentialForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// creating a new credential\nconst data = {\n username: 'foobar',\n password: 'fuubar',\n customerId: 'foobar-0001'\n\n // optionally you can define an `expiredTime` to \n // limit the duration of the credential\n\n //expiredTime: '2017-09-18T19:17:39Z'\n};\n\n// the ID is optional\nconst firstCredential = await api.customerAuthentication.createCredential({data});\n\n// or you can provide one\nconst secondCredential = await api.customerAuthentication.createCredential({id: 'my-second-id', data});\n\n\n\n\n// updating a credential\nconst data = {\n username: 'foobar',\n password: 'hell0'\n};\n\nconst secondCredential = await api.customerAuthentication.updateCredential({id: 'my-second-id', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$customerCredentialForm = \\Rebilly\\Sdk\\Model\\CustomerCredential::from([])\n ->setCustomerId('customerId')\n ->setUsername('test')\n ->setPassword('1234');\n\ntry {\n $customerCredential = $service->customerAuthentication()->updateCredential('credentialId', $customerCredentialForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/CustomerCredential","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerCredential"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Credential updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerCredential"}},"schemaId":"components/schemas/CustomerCredential","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Credential created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerCredential"}},"schemaId":"components/schemas/CustomerCredential","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1credentials~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerCredential","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerCredential"}}},{"code":"201","schemaId":"components/schemas/CustomerCredential","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerCredential"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-authentication/putcredential"}],"panels":[]}]},"httpPath":"/credentials/{id}"},{"label":"Delete a credential","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/deletecredential","routeSlug":"/docs/dev-docs/api/customer-authentication/deletecredential","metadata":{"seo":{"title":"Delete a credential","description":"Deletes an authentication credential with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteCredential","name":"Delete a credential","isWebhook":false,"pointer":"/paths/~1credentials~1{id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an authentication credential with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1credentials~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/credentials/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","404","429"],"pointer":"/credentials/{id}","href":"customer-authentication/deletecredential","openApiOperationId":"DeleteCredential","summary":"Delete a credential","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$client->customerCredentials()->delete('credentialId');\n"},{"lang":"JavaScript","source":"const request = await api.customerAuthentication.deleteCredential({id: 'my-second-key'});\n\n// the request does not return any fields but\n// you can confirm the success using the status code\nconsole.log(request.response.status); // 204"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$service->customerAuthentication()->deleteCredential('credentialId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Credential deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1credentials~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-authentication/deletecredential"}],"panels":[]}]},"httpPath":"/credentials/{id}"},{"label":"Retrieve tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/getpasswordtokencollection","routeSlug":"/docs/dev-docs/api/customer-authentication/getpasswordtokencollection","metadata":{"seo":{"title":"Retrieve tokens","description":"Retrieves a list of reset password tokens."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPasswordTokenCollection","name":"Retrieve tokens","isWebhook":false,"pointer":"/paths/~1password-tokens/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve tokens","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of reset password tokens."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."}],"pointer":"/paths/~1password-tokens/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/password-tokens","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/password-tokens","href":"customer-authentication/getpasswordtokencollection","openApiOperationId":"GetPasswordTokenCollection","summary":"Retrieve tokens","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.customerAuthentication.getAllResetPasswordTokens();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100};\nconst secondCollection = await api.customerAuthentication.getAllResetPasswordTokens(params);\n\n// access the collection items, each item is a ResetPasswordToken\nsecondCollection.items.forEach(token => console.log(token.fields.token));\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$passwordTokens = $service->customerAuthentication()->getAllResetPasswordTokens();"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of reset password tokens retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_796"}},"schemaId":"schema_796","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1password-tokens/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_796","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_796"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-authentication/getpasswordtokencollection"}],"panels":[]}]},"httpPath":"/password-tokens"},{"label":"Create a reset password token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/postpasswordtoken","routeSlug":"/docs/dev-docs/api/customer-authentication/postpasswordtoken","metadata":{"seo":{"title":"Create a reset password token","description":"Creates a reset password token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPasswordToken","name":"Create a reset password token","isWebhook":false,"pointer":"/paths/~1password-tokens/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a reset password token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a reset password token."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResetPasswordToken"}},"schemaId":"components/schemas/ResetPasswordToken","pointer":"/paths/~1password-tokens/post/requestBody","description":"ResetPasswordToken resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/password-tokens","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ResetPasswordToken"}},"responseCodes":["201","401","403","422","429"],"pointer":"/password-tokens","href":"customer-authentication/postpasswordtoken","openApiOperationId":"PostPasswordToken","summary":"Create a reset password token","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// first set the required properties for the new credential\nconst data = {\n username: 'foobar',\n password: 'fuubar',\n // the `credential` expects \n // the customer credential's ID\n credential: 'foobar-0001'\n\n // optionally you can define an `expiredTime` to \n // limit the duration of the reset token\n\n //expiredTime: '2017-09-18T19:17:39Z'\n};\n\nconst resetToken = await api.customerAuthentication.createResetPasswordToken({data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$resetPasswordTokenForm = new \\Rebilly\\Sdk\\Model\\ResetPasswordToken();\n$resetPasswordTokenForm->setUsername('username');\n\ntry {\n $tokens = $coreService->customerAuthentication()->createResetPasswordToken($resetPasswordTokenForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/ResetPasswordToken","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResetPasswordToken"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Reset password token created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResetPasswordToken"}},"schemaId":"components/schemas/ResetPasswordToken","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1password-tokens/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ResetPasswordToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResetPasswordToken"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-authentication/postpasswordtoken"}],"panels":[]}]},"httpPath":"/password-tokens"},{"label":"Retrieve a reset password token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/getpasswordtoken","routeSlug":"/docs/dev-docs/api/customer-authentication/getpasswordtoken","metadata":{"seo":{"title":"Retrieve a reset password token","description":"Retrieves a reset password token with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPasswordToken","name":"Retrieve a reset password token","isWebhook":false,"pointer":"/paths/~1password-tokens~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a reset password token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a reset password token with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1password-tokens~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/password-tokens/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/password-tokens/{id}","href":"customer-authentication/getpasswordtoken","openApiOperationId":"GetPasswordToken","summary":"Retrieve a reset password token","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const token = await api.customerAuthentication.getResetPasswordToken({id: 'my-first-id'});\nconsole.log(token.fields.credential);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$passwordToken = $service->customerAuthentication()->getResetPasswordToken('tokenId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Reset password token retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResetPasswordToken"}},"schemaId":"components/schemas/ResetPasswordToken"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1password-tokens~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResetPasswordToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResetPasswordToken"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-authentication/getpasswordtoken"}],"panels":[]}]},"httpPath":"/password-tokens/{id}"},{"label":"Delete a reset password token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customer-authentication/deletepasswordtoken","routeSlug":"/docs/dev-docs/api/customer-authentication/deletepasswordtoken","metadata":{"seo":{"title":"Delete a reset password token","description":"Deletes a reset password token with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePasswordToken","name":"Delete a reset password token","isWebhook":false,"pointer":"/paths/~1password-tokens~1{id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a reset password token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a reset password token with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1password-tokens~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/password-tokens/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","409","429"],"pointer":"/password-tokens/{id}","href":"customer-authentication/deletepasswordtoken","openApiOperationId":"DeletePasswordToken","summary":"Delete a reset password token","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const request = await api.customerAuthentication.deleteResetPasswordToken({id: 'my-second-key'});\n\n// the request does not return any fields but\n// you can confirm the success using the status code\nconsole.log(request.response.status); // 204"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$service->customerAuthentication()->deleteResetPasswordToken('tokenId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Reset password token deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1password-tokens~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-authentication/deletepasswordtoken"}],"panels":[]}]},"httpPath":"/password-tokens/{id}"}],"content":{"contentType":"group","meta":{"name":"Customer authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer authentication","showPageActions":true},{"nodeType":"markdoc","content":"Use these operations to validate the identity of users and manage authentication credentials."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/authentication-options","summary":"Retrieve authentication options","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-authentication/getauthenticationoption","deprecated":false},{"title":"/authentication-options","summary":"Change authentication options","prefix":{"name":"put","color":"put"},"badges":[],"link":"/customer-authentication/putauthenticationoption","deprecated":false},{"title":"/authentication-tokens","summary":"Retrieve authentication tokens","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-authentication/getauthenticationtokencollection","deprecated":false},{"title":"/authentication-tokens","summary":"Login a customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customer-authentication/postauthenticationtoken","deprecated":false},{"title":"/authentication-tokens/{token}","summary":"Verify an authentication token","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-authentication/getauthenticationtokenverification","deprecated":false},{"title":"/authentication-tokens/{token}","summary":"Logout a customer","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/customer-authentication/deleteauthenticationtoken","deprecated":false},{"title":"/authentication-tokens/{token}/exchange","summary":"Exchange an authentication token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customer-authentication/postauthenticationtokenexchange","deprecated":false},{"title":"/credentials","summary":"Retrieve credentials","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-authentication/getcredentialcollection","deprecated":false},{"title":"/credentials","summary":"Create a credential","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customer-authentication/postcredential","deprecated":false},{"title":"/credentials/{id}","summary":"Retrieve a credential","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-authentication/getcredential","deprecated":false},{"title":"/credentials/{id}","summary":"Upsert a credential","prefix":{"name":"put","color":"put"},"badges":[],"link":"/customer-authentication/putcredential","deprecated":false},{"title":"/credentials/{id}","summary":"Delete a credential","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/customer-authentication/deletecredential","deprecated":false},{"title":"/password-tokens","summary":"Retrieve tokens","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-authentication/getpasswordtokencollection","deprecated":false},{"title":"/password-tokens","summary":"Create a reset password token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customer-authentication/postpasswordtoken","deprecated":false},{"title":"/password-tokens/{id}","summary":"Retrieve a reset password token","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-authentication/getpasswordtoken","deprecated":false},{"title":"/password-tokens/{id}","summary":"Delete a reset password token","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/customer-authentication/deletepasswordtoken","deprecated":false}]}]}]}]}},{"type":"group","label":"Account registration settings","link":"/docs/dev-docs/api/account-registration-settings","routeSlug":"/docs/dev-docs/api/account-registration-settings","items":[{"label":"Retrieve account registration settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/account-registration-settings/getaccountregistrationsettingscollection","routeSlug":"/docs/dev-docs/api/account-registration-settings/getaccountregistrationsettingscollection","metadata":{"seo":{"title":"Retrieve account registration settings","description":"Retrieves a list of all account registration settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetAccountRegistrationSettingsCollection","name":"Retrieve account registration settings","isWebhook":false,"pointer":"/paths/~1account-registration-settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve account registration settings","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all account registration settings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."}],"pointer":"/paths/~1account-registration-settings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account-registration-settings","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/account-registration-settings","href":"account-registration-settings/getaccountregistrationsettingscollection","openApiOperationId":"GetAccountRegistrationSettingsCollection","summary":"Retrieve account registration settings","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of account registration settings retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_797"}},"schemaId":"schema_797","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1account-registration-settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_797","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_797"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-registration-settings/getaccountregistrationsettingscollection"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/account-registration-settings"},{"label":"Create account registration settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/account-registration-settings/postaccountregistrationsettings","routeSlug":"/docs/dev-docs/api/account-registration-settings/postaccountregistrationsettings","metadata":{"seo":{"title":"Create account registration settings","description":"Creates a new account registration settings resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostAccountRegistrationSettings","name":"Create account registration settings","isWebhook":false,"pointer":"/paths/~1account-registration-settings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create account registration settings","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new account registration settings resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountRegistrationSettings"}},"schemaId":"components/schemas/AccountRegistrationSettings","pointer":"/paths/~1account-registration-settings/post/requestBody","description":"Account registration settings resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/account-registration-settings","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountRegistrationSettings"}},"responseCodes":["201","401","403","409","422","429"],"pointer":"/account-registration-settings","href":"account-registration-settings/postaccountregistrationsettings","openApiOperationId":"PostAccountRegistrationSettings","summary":"Create account registration settings","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/AccountRegistrationSettings","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountRegistrationSettings"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Account registration settings created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountRegistrationSettings"}},"schemaId":"components/schemas/AccountRegistrationSettings","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1account-registration-settings/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/AccountRegistrationSettings","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountRegistrationSettings"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-registration-settings/postaccountregistrationsettings"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/account-registration-settings"},{"label":"Retrieve account registration settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/account-registration-settings/getaccountregistrationsettings","routeSlug":"/docs/dev-docs/api/account-registration-settings/getaccountregistrationsettings","metadata":{"seo":{"title":"Retrieve account registration settings","description":"Retrieves account registration settings with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetAccountRegistrationSettings","name":"Retrieve account registration settings","isWebhook":false,"pointer":"/paths/~1account-registration-settings~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve account registration settings","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves account registration settings with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1account-registration-settings~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account-registration-settings/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/account-registration-settings/{id}","href":"account-registration-settings/getaccountregistrationsettings","openApiOperationId":"GetAccountRegistrationSettings","summary":"Retrieve account registration settings","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account registration settings retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountRegistrationSettings"}},"schemaId":"components/schemas/AccountRegistrationSettings"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1account-registration-settings~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountRegistrationSettings","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountRegistrationSettings"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-registration-settings/getaccountregistrationsettings"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/account-registration-settings/{id}"},{"label":"Upsert account registration settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/account-registration-settings/putaccountregistrationsettings","routeSlug":"/docs/dev-docs/api/account-registration-settings/putaccountregistrationsettings","metadata":{"seo":{"title":"Upsert account registration settings","description":"Creates or updates account registration settings with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutAccountRegistrationSettings","name":"Upsert account registration settings","isWebhook":false,"pointer":"/paths/~1account-registration-settings~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert account registration settings","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates account registration settings with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1account-registration-settings~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountRegistrationSettings"}},"schemaId":"components/schemas/AccountRegistrationSettings","pointer":"/paths/~1account-registration-settings~1{id}/put/requestBody","description":"Account registration settings resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/account-registration-settings/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountRegistrationSettings"}},"responseCodes":["200","201","401","403","409","422","429"],"pointer":"/account-registration-settings/{id}","href":"account-registration-settings/putaccountregistrationsettings","openApiOperationId":"PutAccountRegistrationSettings","summary":"Upsert account registration settings","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/AccountRegistrationSettings","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountRegistrationSettings"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account registration settings updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountRegistrationSettings"}},"schemaId":"components/schemas/AccountRegistrationSettings","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Account registration settings created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountRegistrationSettings"}},"schemaId":"components/schemas/AccountRegistrationSettings","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1account-registration-settings~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountRegistrationSettings","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountRegistrationSettings"}}},{"code":"201","schemaId":"components/schemas/AccountRegistrationSettings","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountRegistrationSettings"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-registration-settings/putaccountregistrationsettings"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/account-registration-settings/{id}"},{"label":"Delete account registration settings","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/account-registration-settings/deleteaccountregistrationsettings","routeSlug":"/docs/dev-docs/api/account-registration-settings/deleteaccountregistrationsettings","metadata":{"seo":{"title":"Delete account registration settings","description":"Deletes account registration settings with a specified ID. Default account registration settings cannot be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteAccountRegistrationSettings","name":"Delete account registration settings","isWebhook":false,"pointer":"/paths/~1account-registration-settings~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete account registration settings","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes account registration settings with a specified ID.\nDefault account registration settings cannot be deleted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1account-registration-settings~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/account-registration-settings/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","409","429"],"pointer":"/account-registration-settings/{id}","href":"account-registration-settings/deleteaccountregistrationsettings","openApiOperationId":"DeleteAccountRegistrationSettings","summary":"Delete account registration settings","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Account registration settings deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1account-registration-settings~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-registration-settings/deleteaccountregistrationsettings"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/account-registration-settings/{id}"}],"content":{"contentType":"group","meta":{"name":"Account registration settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account registration settings","showPageActions":true},{"nodeType":"markdoc","content":"Use account registration settings operations to configure the fields and steps that customers see during account registration."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account-registration-settings","summary":"Retrieve account registration settings","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/account-registration-settings/getaccountregistrationsettingscollection","deprecated":false},{"title":"/account-registration-settings","summary":"Create account registration settings","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/account-registration-settings/postaccountregistrationsettings","deprecated":false},{"title":"/account-registration-settings/{id}","summary":"Retrieve account registration settings","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/account-registration-settings/getaccountregistrationsettings","deprecated":false},{"title":"/account-registration-settings/{id}","summary":"Upsert account registration settings","prefix":{"name":"put","color":"put"},"badges":[{"name":"Experimental"}],"link":"/account-registration-settings/putaccountregistrationsettings","deprecated":false},{"title":"/account-registration-settings/{id}","summary":"Delete account registration settings","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Experimental"}],"link":"/account-registration-settings/deleteaccountregistrationsettings","deprecated":false}]}]}]}]}},{"type":"group","label":"Tags","link":"/docs/dev-docs/api/tags","routeSlug":"/docs/dev-docs/api/tags","items":[{"label":"Retrieve tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/gettagcollection","routeSlug":"/docs/dev-docs/api/tags/gettagcollection","metadata":{"seo":{"title":"Retrieve tags","description":"Retrieves a list of tags."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTagCollection","name":"Retrieve tags","isWebhook":false,"pointer":"/paths/~1tags/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of tags."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1tags/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tags","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"q","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/tags","href":"tags/gettagcollection","openApiOperationId":"GetTagCollection","summary":"Retrieve tags","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$tagsPaginator = $service->tags()->getAllPaginator(limit: 5);\nforeach ($tagsPaginator as $tagPage) {\n printf(\"Tags page %d/%d\\n\", $tagsPaginator->key() + 1, $tagsPaginator->count());\n foreach ($tagPage as $tag) {\n printf(\"Tag #%s: %s\\n\", $tag->getId(), $tag->getName());\n }\n}\n\n// OR\n\n$tags = $service->tags()->getAll();\nforeach ($tags as $tag) {\n printf(\"Tag #%s: %s\\n\", $tag->getId(), $tag->getName());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of tags retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_798"}},"schemaId":"schema_798","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_798","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_798"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/gettagcollection"}],"panels":[]}]},"httpPath":"/tags"},{"label":"Create a tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/posttag","routeSlug":"/docs/dev-docs/api/tags/posttag","metadata":{"seo":{"title":"Create a tag","description":"Creates a tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostTag","name":"Create a tag","isWebhook":false,"pointer":"/paths/~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Tag"}},"schemaId":"components/schemas/Tag","pointer":"/paths/~1tags/post/requestBody","description":"Tag resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tags","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Tag"}},"responseCodes":["201","401","403","409","422","429"],"pointer":"/tags","href":"tags/posttag","openApiOperationId":"PostTag","summary":"Create a tag","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$tagForm = new \\Rebilly\\Sdk\\Model\\Tag();\n$tagForm->setName('tag-name');\n$tagForm->setType(\\Rebilly\\Sdk\\Model\\Tag::TYPE_CUSTOMER);\n\ntry {\n $service->tags()->create($tagForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Tag","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Tag"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Tag created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Tag"}},"schemaId":"components/schemas/Tag","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Tag","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Tag"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/posttag"}],"panels":[]}]},"httpPath":"/tags"},{"label":"Retrieve a tag","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/gettag","routeSlug":"/docs/dev-docs/api/tags/gettag","metadata":{"seo":{"title":"Retrieve a tag","description":"Retrieves a tag with a specified name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTag","name":"Retrieve a tag","isWebhook":false,"pointer":"/paths/~1tags~1{tag}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a tag with a specified name."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag","in":"path","schemaId":"schema_799","description":"Name of the tag.","required":true}],"pointer":"/paths/~1tags~1{tag}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tags/{tag}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"tag","in":"path","required":true,"schemaId":"schema_799"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/tags/{tag}","href":"tags/gettag","openApiOperationId":"GetTag","summary":"Retrieve a tag","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag with a specified name retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Tag"}},"schemaId":"components/schemas/Tag"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1tags~1{tag}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Tag","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Tag"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/gettag"}],"panels":[]}]},"httpPath":"/tags/{tag}"},{"label":"Update a tag","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/patchtag","routeSlug":"/docs/dev-docs/api/tags/patchtag","metadata":{"seo":{"title":"Update a tag","description":"Updates a tag with a specified name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PatchTag","name":"Update a tag","isWebhook":false,"pointer":"/paths/~1tags~1{tag}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a tag with a specified name."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag","in":"path","schemaId":"schema_799","description":"Name of the tag.","required":true}],"pointer":"/paths/~1tags~1{tag}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_800"}},"schemaId":"schema_800","pointer":"/paths/~1tags~1{tag}/patch/requestBody","description":"Tag resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/tags/{tag}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"tag","in":"path","required":true,"schemaId":"schema_799"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_800"}},"responseCodes":["200","401","403","404","409","422","429"],"pointer":"/tags/{tag}","href":"tags/patchtag","openApiOperationId":"PatchTag","summary":"Update a tag","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_800","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_800"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Tag"}},"schemaId":"components/schemas/Tag","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags~1{tag}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Tag","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Tag"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/patchtag"}],"panels":[]}]},"httpPath":"/tags/{tag}"},{"label":"Delete a tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/deletetag","routeSlug":"/docs/dev-docs/api/tags/deletetag","metadata":{"seo":{"title":"Delete a tag","description":"Deletes a tag with a specified name. This is an asynchronous operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteTag","name":"Delete a tag","isWebhook":false,"pointer":"/paths/~1tags~1{tag}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a tag with a specified name.\nThis is an asynchronous operation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag","in":"path","schemaId":"schema_799","description":"Name of the tag.","required":true}],"pointer":"/paths/~1tags~1{tag}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tags/{tag}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"tag","in":"path","required":true,"schemaId":"schema_799"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","429"],"pointer":"/tags/{tag}","href":"tags/deletetag","openApiOperationId":"DeleteTag","summary":"Delete a tag","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Tag deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags~1{tag}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/deletetag"}],"panels":[]}]},"httpPath":"/tags/{tag}"},{"label":"Tag a list of customers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/posttagcustomercollection","routeSlug":"/docs/dev-docs/api/tags/posttagcustomercollection","metadata":{"seo":{"title":"Tag a list of customers","description":"Tags a list of customers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostTagCustomerCollection","name":"Tag a list of customers","isWebhook":false,"pointer":"/paths/~1tags~1{tag}~1customers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag a list of customers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Tags a list of customers.\n\nIf a customer in the list already has the specified tag applied, the customer is ignored.\nThis is an asynchronous operation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag","in":"path","schemaId":"schema_799","description":"Name of the tag.","required":true}],"pointer":"/paths/~1tags~1{tag}~1customers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_801"}},"schemaId":"schema_801","pointer":"/paths/~1tags~1{tag}~1customers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tags/{tag}/customers","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"tag","in":"path","required":true,"schemaId":"schema_799"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_801"}},"responseCodes":["204","401","403","422","429"],"pointer":"/tags/{tag}/customers","href":"tags/posttagcustomercollection","openApiOperationId":"PostTagCustomerCollection","summary":"Tag a list of customers","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_801","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_801"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Customers tagging process has been scheduled.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags~1{tag}~1customers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/posttagcustomercollection"}],"panels":[]}]},"httpPath":"/tags/{tag}/customers"},{"label":"Untag a list of customers","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/deletetagcustomercollection","routeSlug":"/docs/dev-docs/api/tags/deletetagcustomercollection","metadata":{"seo":{"title":"Untag a list of customers","description":"Untag a list of customers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteTagCustomerCollection","name":"Untag a list of customers","isWebhook":false,"pointer":"/paths/~1tags~1{tag}~1customers/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Untag a list of customers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Untag a list of customers.\n\nIf a customer in the list does not have the specified tag applied, the customer is ignored.\nThis is an asynchronous operation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag","in":"path","schemaId":"schema_799","description":"Name of the tag.","required":true}],"pointer":"/paths/~1tags~1{tag}~1customers/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_801"}},"schemaId":"schema_801","pointer":"/paths/~1tags~1{tag}~1customers/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tags/{tag}/customers","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"tag","in":"path","required":true,"schemaId":"schema_799"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_801"}},"responseCodes":["204","401","403","422","429"],"pointer":"/tags/{tag}/customers","href":"tags/deletetagcustomercollection","openApiOperationId":"DeleteTagCustomerCollection","summary":"Untag a list of customers","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_801","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_801"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Customers untagging process has been scheduled.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags~1{tag}~1customers/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/deletetagcustomercollection"}],"panels":[]}]},"httpPath":"/tags/{tag}/customers"},{"label":"Tag a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/posttagcustomer","routeSlug":"/docs/dev-docs/api/tags/posttagcustomer","metadata":{"seo":{"title":"Tag a customer","description":"Tags a customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostTagCustomer","name":"Tag a customer","isWebhook":false,"pointer":"/paths/~1tags~1{tag}~1customers~1{customerId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Tags a customer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag","in":"path","schemaId":"schema_799","description":"Name of the tag.","required":true},{"name":"customerId","in":"path","schemaId":"schema_788","description":"ID of the customer.","required":true}],"pointer":"/paths/~1tags~1{tag}~1customers~1{customerId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tags/{tag}/customers/{customerId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"tag","in":"path","required":true,"schemaId":"schema_799"},{"name":"customerId","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","429"],"pointer":"/tags/{tag}/customers/{customerId}","href":"tags/posttagcustomer","openApiOperationId":"PostTagCustomer","summary":"Tag a customer","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Customer tagged.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags~1{tag}~1customers~1{customerId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/posttagcustomer"}],"panels":[]}]},"httpPath":"/tags/{tag}/customers/{customerId}"},{"label":"Untag a customer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/deletetagcustomer","routeSlug":"/docs/dev-docs/api/tags/deletetagcustomer","metadata":{"seo":{"title":"Untag a customer","description":"Untags a customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteTagCustomer","name":"Untag a customer","isWebhook":false,"pointer":"/paths/~1tags~1{tag}~1customers~1{customerId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Untag a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Untags a customer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag","in":"path","schemaId":"schema_799","description":"Name of the tag.","required":true},{"name":"customerId","in":"path","schemaId":"schema_788","description":"ID of the customer.","required":true}],"pointer":"/paths/~1tags~1{tag}~1customers~1{customerId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tags/{tag}/customers/{customerId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"tag","in":"path","required":true,"schemaId":"schema_799"},{"name":"customerId","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","429"],"pointer":"/tags/{tag}/customers/{customerId}","href":"tags/deletetagcustomer","openApiOperationId":"DeleteTagCustomer","summary":"Untag a customer","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Customer untagged.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags~1{tag}~1customers~1{customerId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/deletetagcustomer"}],"panels":[]}]},"httpPath":"/tags/{tag}/customers/{customerId}"},{"label":"Tag a list of KYC documents","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/posttagkycdocumentcollection","routeSlug":"/docs/dev-docs/api/tags/posttagkycdocumentcollection","metadata":{"seo":{"title":"Tag a list of KYC documents","description":"Tags a list of KYC documents."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostTagKycDocumentCollection","name":"Tag a list of KYC documents","isWebhook":false,"pointer":"/paths/~1tags~1{tag}~1kyc-documents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag a list of KYC documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Tags a list of KYC documents.\n\nIf a KYC document in the list already has the specified tag applied, the KYC document is ignored.\nThis is an asynchronous operation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag","in":"path","schemaId":"schema_799","description":"Name of the tag.","required":true}],"pointer":"/paths/~1tags~1{tag}~1kyc-documents/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_802"}},"schemaId":"schema_802","pointer":"/paths/~1tags~1{tag}~1kyc-documents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tags/{tag}/kyc-documents","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"tag","in":"path","required":true,"schemaId":"schema_799"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_802"}},"responseCodes":["204","401","403","422","429"],"pointer":"/tags/{tag}/kyc-documents","href":"tags/posttagkycdocumentcollection","openApiOperationId":"PostTagKycDocumentCollection","summary":"Tag a list of KYC documents","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_802","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_802"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"KYC documents tagging process has been scheduled.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags~1{tag}~1kyc-documents/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/posttagkycdocumentcollection"}],"panels":[]}]},"httpPath":"/tags/{tag}/kyc-documents"},{"label":"Untag a list of KYC documents","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/deletetagkycdocumentcollection","routeSlug":"/docs/dev-docs/api/tags/deletetagkycdocumentcollection","metadata":{"seo":{"title":"Untag a list of KYC documents","description":"Untags a list of KYC documents."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteTagKycDocumentCollection","name":"Untag a list of KYC documents","isWebhook":false,"pointer":"/paths/~1tags~1{tag}~1kyc-documents/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Untag a list of KYC documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Untags a list of KYC documents.\n\nIf a KYC document in the list does not have the specified tag applied, the KYC document is ignored.\nThis is an asynchronous operation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag","in":"path","schemaId":"schema_799","description":"Name of the tag.","required":true}],"pointer":"/paths/~1tags~1{tag}~1kyc-documents/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_802"}},"schemaId":"schema_802","pointer":"/paths/~1tags~1{tag}~1kyc-documents/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tags/{tag}/kyc-documents","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"tag","in":"path","required":true,"schemaId":"schema_799"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_802"}},"responseCodes":["204","401","403","422","429"],"pointer":"/tags/{tag}/kyc-documents","href":"tags/deletetagkycdocumentcollection","openApiOperationId":"DeleteTagKycDocumentCollection","summary":"Untag a list of KYC documents","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_802","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_802"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"KYC documents untagging process has been scheduled.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags~1{tag}~1kyc-documents/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/deletetagkycdocumentcollection"}],"panels":[]}]},"httpPath":"/tags/{tag}/kyc-documents"},{"label":"Tag a KYC document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/posttagkycdocument","routeSlug":"/docs/dev-docs/api/tags/posttagkycdocument","metadata":{"seo":{"title":"Tag a KYC document","description":"Tags a KYC document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostTagKycDocument","name":"Tag a KYC document","isWebhook":false,"pointer":"/paths/~1tags~1{tag}~1kyc-documents~1{kycDocumentId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag a KYC document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Tags a KYC document."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag","in":"path","schemaId":"schema_799","description":"Name of the tag.","required":true},{"name":"kycDocumentId","in":"path","schemaId":"schema_788","description":"ID of the KYC document.","required":true}],"pointer":"/paths/~1tags~1{tag}~1kyc-documents~1{kycDocumentId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tags/{tag}/kyc-documents/{kycDocumentId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"tag","in":"path","required":true,"schemaId":"schema_799"},{"name":"kycDocumentId","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","429"],"pointer":"/tags/{tag}/kyc-documents/{kycDocumentId}","href":"tags/posttagkycdocument","openApiOperationId":"PostTagKycDocument","summary":"Tag a KYC document","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"KYC document tagged.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags~1{tag}~1kyc-documents~1{kycDocumentId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/posttagkycdocument"}],"panels":[]}]},"httpPath":"/tags/{tag}/kyc-documents/{kycDocumentId}"},{"label":"Untag a KYC document","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/deletetagkycdocument","routeSlug":"/docs/dev-docs/api/tags/deletetagkycdocument","metadata":{"seo":{"title":"Untag a KYC document","description":"Untags a KYC document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteTagKycDocument","name":"Untag a KYC document","isWebhook":false,"pointer":"/paths/~1tags~1{tag}~1kyc-documents~1{kycDocumentId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Untag a KYC document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Untags a KYC document."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag","in":"path","schemaId":"schema_799","description":"Name of the tag.","required":true},{"name":"kycDocumentId","in":"path","schemaId":"schema_788","description":"ID of the KYC document.","required":true}],"pointer":"/paths/~1tags~1{tag}~1kyc-documents~1{kycDocumentId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tags/{tag}/kyc-documents/{kycDocumentId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"tag","in":"path","required":true,"schemaId":"schema_799"},{"name":"kycDocumentId","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","429"],"pointer":"/tags/{tag}/kyc-documents/{kycDocumentId}","href":"tags/deletetagkycdocument","openApiOperationId":"DeleteTagKycDocument","summary":"Untag a KYC document","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"KYC document untagged.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags~1{tag}~1kyc-documents~1{kycDocumentId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/deletetagkycdocument"}],"panels":[]}]},"httpPath":"/tags/{tag}/kyc-documents/{kycDocumentId}"},{"label":"Tag a list of AML checks","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/posttagamlcheckcollection","routeSlug":"/docs/dev-docs/api/tags/posttagamlcheckcollection","metadata":{"seo":{"title":"Tag a list of AML checks","description":"Tags a list of AML checks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostTagAmlCheckCollection","name":"Tag a list of AML checks","isWebhook":false,"pointer":"/paths/~1tags~1{tag}~1aml-checks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag a list of AML checks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Tags a list of AML checks.\n\nIf an AML check in the list already has the specified tag applied, the AML check is ignored.\nThis is an asynchronous operation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag","in":"path","schemaId":"schema_799","description":"Name of the tag.","required":true}],"pointer":"/paths/~1tags~1{tag}~1aml-checks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_803"}},"schemaId":"schema_803","pointer":"/paths/~1tags~1{tag}~1aml-checks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tags/{tag}/aml-checks","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"tag","in":"path","required":true,"schemaId":"schema_799"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_803"}},"responseCodes":["204","401","403","422","429"],"pointer":"/tags/{tag}/aml-checks","href":"tags/posttagamlcheckcollection","openApiOperationId":"PostTagAmlCheckCollection","summary":"Tag a list of AML checks","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_803","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_803"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"AML checks tagging process has been scheduled.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags~1{tag}~1aml-checks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/posttagamlcheckcollection"}],"panels":[]}]},"httpPath":"/tags/{tag}/aml-checks"},{"label":"Untag a list of AML checks","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/deletetagamlcheckcollection","routeSlug":"/docs/dev-docs/api/tags/deletetagamlcheckcollection","metadata":{"seo":{"title":"Untag a list of AML checks","description":"Untags a list of AML checks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteTagAmlCheckCollection","name":"Untag a list of AML checks","isWebhook":false,"pointer":"/paths/~1tags~1{tag}~1aml-checks/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Untag a list of AML checks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Untags a list of AML checks.\n\nIf an AML check in the list does not have the specified tag applied, the AML check is ignored.\nThis is an asynchronous operation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag","in":"path","schemaId":"schema_799","description":"Name of the tag.","required":true}],"pointer":"/paths/~1tags~1{tag}~1aml-checks/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_803"}},"schemaId":"schema_803","pointer":"/paths/~1tags~1{tag}~1aml-checks/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tags/{tag}/aml-checks","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"tag","in":"path","required":true,"schemaId":"schema_799"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_803"}},"responseCodes":["204","401","403","422","429"],"pointer":"/tags/{tag}/aml-checks","href":"tags/deletetagamlcheckcollection","openApiOperationId":"DeleteTagAmlCheckCollection","summary":"Untag a list of AML checks","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_803","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_803"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"AML checks untagging process has been scheduled.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags~1{tag}~1aml-checks/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/deletetagamlcheckcollection"}],"panels":[]}]},"httpPath":"/tags/{tag}/aml-checks"},{"label":"Tag an AML check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/posttagamlcheck","routeSlug":"/docs/dev-docs/api/tags/posttagamlcheck","metadata":{"seo":{"title":"Tag an AML check","description":"Tags an AML check."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostTagAmlCheck","name":"Tag an AML check","isWebhook":false,"pointer":"/paths/~1tags~1{tag}~1aml-checks~1{amlCheckId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag an AML check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Tags an AML check.\n\nIf an AML check in the list does not have the specified tag applied, the AML check is ignored."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag","in":"path","schemaId":"schema_799","description":"Name of the tag.","required":true},{"name":"amlCheckId","in":"path","schemaId":"schema_782","description":"ID of the AML check to tag.","required":true}],"pointer":"/paths/~1tags~1{tag}~1aml-checks~1{amlCheckId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tags/{tag}/aml-checks/{amlCheckId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"tag","in":"path","required":true,"schemaId":"schema_799"},{"name":"amlCheckId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","429"],"pointer":"/tags/{tag}/aml-checks/{amlCheckId}","href":"tags/posttagamlcheck","openApiOperationId":"PostTagAmlCheck","summary":"Tag an AML check","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"AML check tagged.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags~1{tag}~1aml-checks~1{amlCheckId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/posttagamlcheck"}],"panels":[]}]},"httpPath":"/tags/{tag}/aml-checks/{amlCheckId}"},{"label":"Untag an AML check","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/deletetagamlcheck","routeSlug":"/docs/dev-docs/api/tags/deletetagamlcheck","metadata":{"seo":{"title":"Untag an AML check","description":"Untags an AML check."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteTagAmlCheck","name":"Untag an AML check","isWebhook":false,"pointer":"/paths/~1tags~1{tag}~1aml-checks~1{amlCheckId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Untag an AML check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Untags an AML check.\n\nIf an AML check in the list does not have the specified tag applied, the AML check is ignored."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag","in":"path","schemaId":"schema_799","description":"Name of the tag.","required":true},{"name":"amlCheckId","in":"path","schemaId":"schema_782","description":"ID of the AML check to tag.","required":true}],"pointer":"/paths/~1tags~1{tag}~1aml-checks~1{amlCheckId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tags/{tag}/aml-checks/{amlCheckId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"tag","in":"path","required":true,"schemaId":"schema_799"},{"name":"amlCheckId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","429"],"pointer":"/tags/{tag}/aml-checks/{amlCheckId}","href":"tags/deletetagamlcheck","openApiOperationId":"DeleteTagAmlCheck","summary":"Untag an AML check","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"AML check untagged.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags~1{tag}~1aml-checks~1{amlCheckId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/deletetagamlcheck"}],"panels":[]}]},"httpPath":"/tags/{tag}/aml-checks/{amlCheckId}"},{"label":"Retrieve tags rules list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/gettagrulecollection","routeSlug":"/docs/dev-docs/api/tags/gettagrulecollection","metadata":{"seo":{"title":"Retrieve tags rules list","description":"Retrieves a list of tags rules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTagRuleCollection","name":"Retrieve tags rules list","isWebhook":false,"pointer":"/paths/~1tags-rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve tags rules list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of tags rules."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."}],"pointer":"/paths/~1tags-rules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tags-rules","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"q","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/tags-rules","href":"tags/gettagrulecollection","openApiOperationId":"GetTagRuleCollection","summary":"Retrieve tags rules list","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of tags rules retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_804"}},"schemaId":"schema_804","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1tags-rules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_804","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_804"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/gettagrulecollection"}],"panels":[]}]},"httpPath":"/tags-rules"},{"label":"Create tags rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/posttagrule","routeSlug":"/docs/dev-docs/api/tags/posttagrule","metadata":{"seo":{"title":"Create tags rule","description":"Creates a tags rule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostTagRule","name":"Create tags rule","isWebhook":false,"pointer":"/paths/~1tags-rules/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create tags rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a tags rule."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagUntagRule"}},"schemaId":"components/schemas/TagUntagRule","pointer":"/paths/~1tags-rules/post/requestBody","description":"Tags rule resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tags-rules","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TagUntagRule"}},"responseCodes":["201","401","403","422","429"],"pointer":"/tags-rules","href":"tags/posttagrule","openApiOperationId":"PostTagRule","summary":"Create tags rule","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/TagUntagRule","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagUntagRule"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Tags rule created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TagUntagRule"}},"schemaId":"components/schemas/TagUntagRule","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags-rules/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TagUntagRule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TagUntagRule"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/posttagrule"}],"panels":[]}]},"httpPath":"/tags-rules"},{"label":"Retrieve a tags rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/gettagrule","routeSlug":"/docs/dev-docs/api/tags/gettagrule","metadata":{"seo":{"title":"Retrieve a tags rule","description":"Retrieves a tags rule with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTagRule","name":"Retrieve a tags rule","isWebhook":false,"pointer":"/paths/~1tags-rules~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a tags rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a tags rule with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1tags-rules~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tags-rules/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/tags-rules/{id}","href":"tags/gettagrule","openApiOperationId":"GetTagRule","summary":"Retrieve a tags rule","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tags rule retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TagUntagRule"}},"schemaId":"components/schemas/TagUntagRule"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1tags-rules~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TagUntagRule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TagUntagRule"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/gettagrule"}],"panels":[]}]},"httpPath":"/tags-rules/{id}"},{"label":"Create a tags rule with specified ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/puttagrule","routeSlug":"/docs/dev-docs/api/tags/puttagrule","metadata":{"seo":{"title":"Create a tags rule with specified ID","description":"Creates a tags rule with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutTagRule","name":"Create a tags rule with specified ID","isWebhook":false,"pointer":"/paths/~1tags-rules~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a tags rule with specified ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a tags rule with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1tags-rules~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagUntagRule"}},"schemaId":"components/schemas/TagUntagRule","pointer":"/paths/~1tags-rules~1{id}/put/requestBody","description":"Tags rule resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tags-rules/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TagUntagRule"}},"responseCodes":["200","201","401","403","422","429"],"pointer":"/tags-rules/{id}","href":"tags/puttagrule","openApiOperationId":"PutTagRule","summary":"Create a tags rule with specified ID","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/TagUntagRule","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagUntagRule"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tags rule updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TagUntagRule"}},"schemaId":"components/schemas/TagUntagRule","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Tags rule created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TagUntagRule"}},"schemaId":"components/schemas/TagUntagRule","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags-rules~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TagUntagRule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TagUntagRule"}}},{"code":"201","schemaId":"components/schemas/TagUntagRule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TagUntagRule"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/puttagrule"}],"panels":[]}]},"httpPath":"/tags-rules/{id}"},{"label":"Delete tags rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/tags/deletetagrule","routeSlug":"/docs/dev-docs/api/tags/deletetagrule","metadata":{"seo":{"title":"Delete tags rule","description":"Deletes a tags rule with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteTagRule","name":"Delete tags rule","isWebhook":false,"pointer":"/paths/~1tags-rules~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete tags rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a tags rule with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1tags-rules~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tags-rules/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","429"],"pointer":"/tags-rules/{id}","href":"tags/deletetagrule","openApiOperationId":"DeleteTagRule","summary":"Delete tags rule","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Tags rule deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tags-rules~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/deletetagrule"}],"panels":[]}]},"httpPath":"/tags-rules/{id}"}],"content":{"contentType":"group","meta":{"name":"Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tags","showPageActions":true},{"nodeType":"markdoc","content":"Use tags to organize and categorize customers or KYC documents based on keywords."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tags","summary":"Retrieve tags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/gettagcollection","deprecated":false},{"title":"/tags","summary":"Create a tag","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/posttag","deprecated":false},{"title":"/tags/{tag}","summary":"Retrieve a tag","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/gettag","deprecated":false},{"title":"/tags/{tag}","summary":"Update a tag","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/tags/patchtag","deprecated":false},{"title":"/tags/{tag}","summary":"Delete a tag","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/deletetag","deprecated":false},{"title":"/tags/{tag}/customers","summary":"Tag a list of customers","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/posttagcustomercollection","deprecated":false},{"title":"/tags/{tag}/customers","summary":"Untag a list of customers","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/deletetagcustomercollection","deprecated":false},{"title":"/tags/{tag}/customers/{customerId}","summary":"Tag a customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/posttagcustomer","deprecated":false},{"title":"/tags/{tag}/customers/{customerId}","summary":"Untag a customer","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/deletetagcustomer","deprecated":false},{"title":"/tags/{tag}/kyc-documents","summary":"Tag a list of KYC documents","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/posttagkycdocumentcollection","deprecated":false},{"title":"/tags/{tag}/kyc-documents","summary":"Untag a list of KYC documents","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/deletetagkycdocumentcollection","deprecated":false},{"title":"/tags/{tag}/kyc-documents/{kycDocumentId}","summary":"Tag a KYC document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/posttagkycdocument","deprecated":false},{"title":"/tags/{tag}/kyc-documents/{kycDocumentId}","summary":"Untag a KYC document","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/deletetagkycdocument","deprecated":false},{"title":"/tags/{tag}/aml-checks","summary":"Tag a list of AML checks","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/posttagamlcheckcollection","deprecated":false},{"title":"/tags/{tag}/aml-checks","summary":"Untag a list of AML checks","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/deletetagamlcheckcollection","deprecated":false},{"title":"/tags/{tag}/aml-checks/{amlCheckId}","summary":"Tag an AML check","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/posttagamlcheck","deprecated":false},{"title":"/tags/{tag}/aml-checks/{amlCheckId}","summary":"Untag an AML check","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/deletetagamlcheck","deprecated":false},{"title":"/tags-rules","summary":"Retrieve tags rules list","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/gettagrulecollection","deprecated":false},{"title":"/tags-rules","summary":"Create tags rule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/posttagrule","deprecated":false},{"title":"/tags-rules/{id}","summary":"Retrieve a tags rule","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/gettagrule","deprecated":false},{"title":"/tags-rules/{id}","summary":"Create a tags rule with specified ID","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tags/puttagrule","deprecated":false},{"title":"/tags-rules/{id}","summary":"Delete tags rule","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/deletetagrule","deprecated":false}]}]}]}]}},{"type":"group","label":"Customers timeline","link":"/docs/dev-docs/api/customers-timeline","routeSlug":"/docs/dev-docs/api/customers-timeline","items":[{"label":"Retrieve customer timeline custom event types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers-timeline/getcustomertimelinecustomeventtypecollection","routeSlug":"/docs/dev-docs/api/customers-timeline/getcustomertimelinecustomeventtypecollection","metadata":{"seo":{"title":"Retrieve customer timeline custom event types","description":"Retrieves a list of customer timeline custom event types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCustomerTimelineCustomEventTypeCollection","name":"Retrieve customer timeline custom event types","isWebhook":false,"pointer":"/paths/~1customer-timeline-custom-events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve customer timeline custom event types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of customer timeline custom event types."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1customer-timeline-custom-events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customer-timeline-custom-events","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/customer-timeline-custom-events","href":"customers-timeline/getcustomertimelinecustomeventtypecollection","openApiOperationId":"GetCustomerTimelineCustomEventTypeCollection","summary":"Retrieve customer timeline custom event types","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of customer timeline custom event types retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_805"}},"schemaId":"schema_805","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1customer-timeline-custom-events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_805","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_805"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers-timeline/getcustomertimelinecustomeventtypecollection"}],"panels":[]}]},"httpPath":"/customer-timeline-custom-events"},{"label":"Create customer timeline custom event type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers-timeline/postcustomertimelinecustomeventtype","routeSlug":"/docs/dev-docs/api/customers-timeline/postcustomertimelinecustomeventtype","metadata":{"seo":{"title":"Create customer timeline custom event type","description":"Creates a customer timeline custom event type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostCustomerTimelineCustomEventType","name":"Create customer timeline custom event type","isWebhook":false,"pointer":"/paths/~1customer-timeline-custom-events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create customer timeline custom event type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a customer timeline custom event type."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerTimelineCustomEvent"}},"schemaId":"components/schemas/CustomerTimelineCustomEvent","pointer":"/paths/~1customer-timeline-custom-events/post/requestBody","description":"Customer timeline custom event type resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customer-timeline-custom-events","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomerTimelineCustomEvent"}},"responseCodes":["201","401","403","422","429"],"pointer":"/customer-timeline-custom-events","href":"customers-timeline/postcustomertimelinecustomeventtype","openApiOperationId":"PostCustomerTimelineCustomEventType","summary":"Create customer timeline custom event type","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/CustomerTimelineCustomEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerTimelineCustomEvent"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Customer timeline custom event type created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerTimelineCustomEvent"}},"schemaId":"components/schemas/CustomerTimelineCustomEvent","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1customer-timeline-custom-events/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CustomerTimelineCustomEvent","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerTimelineCustomEvent"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers-timeline/postcustomertimelinecustomeventtype"}],"panels":[]}]},"httpPath":"/customer-timeline-custom-events"},{"label":"Retrieve customer timeline custom event type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers-timeline/getcustomertimelinecustomeventtype","routeSlug":"/docs/dev-docs/api/customers-timeline/getcustomertimelinecustomeventtype","metadata":{"seo":{"title":"Retrieve customer timeline custom event type","description":"Retrieves a customer timeline custom event type with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCustomerTimelineCustomEventType","name":"Retrieve customer timeline custom event type","isWebhook":false,"pointer":"/paths/~1customer-timeline-custom-events~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve customer timeline custom event type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a customer timeline custom event type with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1customer-timeline-custom-events~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customer-timeline-custom-events/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/customer-timeline-custom-events/{id}","href":"customers-timeline/getcustomertimelinecustomeventtype","openApiOperationId":"GetCustomerTimelineCustomEventType","summary":"Retrieve customer timeline custom event type","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Customer timeline custom event type retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerTimelineCustomEvent"}},"schemaId":"components/schemas/CustomerTimelineCustomEvent","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1customer-timeline-custom-events~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerTimelineCustomEvent","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerTimelineCustomEvent"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers-timeline/getcustomertimelinecustomeventtype"}],"panels":[]}]},"httpPath":"/customer-timeline-custom-events/{id}"},{"label":"Retrieve customer timeline messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers-timeline/getcustomertimelinecollection","routeSlug":"/docs/dev-docs/api/customers-timeline/getcustomertimelinecollection","metadata":{"seo":{"title":"Retrieve customer timeline messages","description":"Retrieves customer timeline messages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCustomerTimelineCollection","name":"Retrieve customer timeline messages","isWebhook":false,"pointer":"/paths/~1customers~1{id}~1timeline/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve customer timeline messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves customer timeline messages."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1customers~1{id}~1timeline/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."}],"pointer":"/paths/~1customers~1{id}~1timeline/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{id}/timeline","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"q","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/customers/{id}/timeline","href":"customers-timeline/getcustomertimelinecollection","openApiOperationId":"GetCustomerTimelineCollection","summary":"Retrieve customer timeline messages","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// all parameters are optional except for the `id`\nconst firstCollection = await api.customers\n .getAllTimelineMessages({id: 'my-customer'});\n\n// alternatively you can specify one or more of them\nconst params = {id: 'my-customer', limit: 20, offset: 100};\nconst secondCollection = await api.customers.getAllTimelineMessages(params);\n\n// access the collection items, each item is a CustomerTimeline\nsecondCollection.items\n .forEach(message => console.log(message.fields.eventType));\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of customer timeline messages retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_806"}},"schemaId":"schema_806","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1customers~1{id}~1timeline/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_806","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_806"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers-timeline/getcustomertimelinecollection"}],"panels":[]}]},"httpPath":"/customers/{id}/timeline"},{"label":"Create a customer timeline comment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers-timeline/postcustomertimeline","routeSlug":"/docs/dev-docs/api/customers-timeline/postcustomertimeline","metadata":{"seo":{"title":"Create a customer timeline comment","description":"Creates a customer timeline comment or custom defined event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostCustomerTimeline","name":"Create a customer timeline comment","isWebhook":false,"pointer":"/paths/~1customers~1{id}~1timeline/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a customer timeline comment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a customer timeline comment or custom defined event."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1customers~1{id}~1timeline/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerTimeline"}},"schemaId":"components/schemas/CustomerTimeline","pointer":"/paths/~1customers~1{id}~1timeline/post/requestBody","description":"Customer timeline resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers/{id}/timeline","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomerTimeline"}},"responseCodes":["201","401","403","422","429"],"pointer":"/customers/{id}/timeline","href":"customers-timeline/postcustomertimeline","openApiOperationId":"PostCustomerTimeline","summary":"Create a customer timeline comment","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// Create a comment\nconst firstComment = await api\n .customers.createTimelineComment({id: 'my-customer-id', data: {message: 'Your comment here'}});\n\n// Using params object, mentions and references\nconst message = `Example of mentions @user@mydomain.com and references #customers-customer-id`;\nconst params = {\n id: 'my-customer-id',\n data: {\n message,\n },\n};\nconst secondComment = await api.customers.createTimelineComment(params);"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/CustomerTimeline","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerTimeline"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Customer timeline comment or custom defined event created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerTimeline"}},"schemaId":"components/schemas/CustomerTimeline","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1customers~1{id}~1timeline/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CustomerTimeline","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerTimeline"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers-timeline/postcustomertimeline"}],"panels":[]}]},"httpPath":"/customers/{id}/timeline"},{"label":"Retrieve a customer timeline message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers-timeline/getcustomertimeline","routeSlug":"/docs/dev-docs/api/customers-timeline/getcustomertimeline","metadata":{"seo":{"title":"Retrieve a customer timeline message","description":"Retrieves a customer message with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCustomerTimeline","name":"Retrieve a customer timeline message","isWebhook":false,"pointer":"/paths/~1customers~1{id}~1timeline~1{messageId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a customer timeline message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a customer message with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"messageId","in":"path","schemaId":"schema_782","description":"ID of the customer timeline message.","required":true}],"pointer":"/paths/~1customers~1{id}~1timeline~1{messageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{id}/timeline/{messageId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"messageId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/customers/{id}/timeline/{messageId}","href":"customers-timeline/getcustomertimeline","openApiOperationId":"GetCustomerTimeline","summary":"Retrieve a customer timeline message","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const message = await api.customers\n .getTimelineMessage({id: 'foobar-001', messageId: 'message-202'});\nconsole.log(message.fields.eventType);"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Customer message retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerTimeline"}},"schemaId":"components/schemas/CustomerTimeline"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1customers~1{id}~1timeline~1{messageId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerTimeline","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerTimeline"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers-timeline/getcustomertimeline"}],"panels":[]}]},"httpPath":"/customers/{id}/timeline/{messageId}"},{"label":"Delete a customer timeline message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/customers-timeline/deletecustomertimeline","routeSlug":"/docs/dev-docs/api/customers-timeline/deletecustomertimeline","metadata":{"seo":{"title":"Delete a customer timeline message","description":"Deletes a customer timeline message with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteCustomerTimeline","name":"Delete a customer timeline message","isWebhook":false,"pointer":"/paths/~1customers~1{id}~1timeline~1{messageId}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a customer timeline message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a customer timeline message with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"messageId","in":"path","schemaId":"schema_782","description":"ID of the customer timeline message.","required":true}],"pointer":"/paths/~1customers~1{id}~1timeline~1{messageId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/customers/{id}/timeline/{messageId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"messageId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","409","429"],"pointer":"/customers/{id}/timeline/{messageId}","href":"customers-timeline/deletecustomertimeline","openApiOperationId":"DeleteCustomerTimeline","summary":"Delete a customer timeline message","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const request = await api.customers\n .deleteTimelineMessage({id: 'foobar-001', messageId: 'message-202'});\n\n// the request does not return any fields but\n// you can confirm the success using the status code\nconsole.log(request.response.status); // 204"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Customer timeline message deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1customers~1{id}~1timeline~1{messageId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers-timeline/deletecustomertimeline"}],"panels":[]}]},"httpPath":"/customers/{id}/timeline/{messageId}"}],"content":{"contentType":"group","meta":{"name":"Customers timeline"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customers timeline","showPageActions":true},{"nodeType":"markdoc","content":"Use customer timelines to maintain an audit trail of changes and activity for each customer."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customer-timeline-custom-events","summary":"Retrieve customer timeline custom event types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers-timeline/getcustomertimelinecustomeventtypecollection","deprecated":false},{"title":"/customer-timeline-custom-events","summary":"Create customer timeline custom event type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers-timeline/postcustomertimelinecustomeventtype","deprecated":false},{"title":"/customer-timeline-custom-events/{id}","summary":"Retrieve customer timeline custom event type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers-timeline/getcustomertimelinecustomeventtype","deprecated":false},{"title":"/customers/{id}/timeline","summary":"Retrieve customer timeline messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers-timeline/getcustomertimelinecollection","deprecated":false},{"title":"/customers/{id}/timeline","summary":"Create a customer timeline comment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers-timeline/postcustomertimeline","deprecated":false},{"title":"/customers/{id}/timeline/{messageId}","summary":"Retrieve a customer timeline message","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers-timeline/getcustomertimeline","deprecated":false},{"title":"/customers/{id}/timeline/{messageId}","summary":"Delete a customer timeline message","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/customers-timeline/deletecustomertimeline","deprecated":false}]}]}]}]}},{"type":"separator","label":"Payment Instruments","content":null},{"type":"group","label":"Payment instruments","link":"/docs/dev-docs/api/payment-instruments","routeSlug":"/docs/dev-docs/api/payment-instruments","items":[{"label":"Retrieve payment instruments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-instruments/getpaymentinstrumentcollection","routeSlug":"/docs/dev-docs/api/payment-instruments/getpaymentinstrumentcollection","metadata":{"seo":{"title":"Retrieve payment instruments","description":"Retrieves a list of payment instruments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPaymentInstrumentCollection","name":"Retrieve payment instruments","isWebhook":false,"pointer":"/paths/~1payment-instruments/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve payment instruments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of payment instruments."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."},{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1payment-instruments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-instruments","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"q","in":"query","schemaId":"schema_782"},{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/payment-instruments","href":"payment-instruments/getpaymentinstrumentcollection","openApiOperationId":"GetPaymentInstrumentCollection","summary":"Retrieve payment instruments","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$paymentInstruments = $client->paymentInstruments()->search([\n 'filter' => 'status:active;method:payment-card',\n]);\n"},{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.paymentInstruments.getAll();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100, sort: '-createdTime'};\nconst secondCollection = await api.paymentInstruments.getAll(params);\n\n// access the collection items, each item is a PaymentInstrument\nsecondCollection.items.forEach(paymentInstrument => console.log(paymentInstrument.fields.customerId));\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$paymentInstrumentsPaginator = $service->paymentInstruments()->getAllPaginator(\n filter: 'status:active;method:payment-card',\n limit: 5\n);\nforeach ($paymentInstrumentsPaginator as $paymentInstrumentsPage) {\n printf(\"Payment instruments page %d/%d\\n\", $paymentInstrumentsPaginator->key() + 1, $paymentInstrumentsPaginator->count());\n foreach ($paymentInstrumentsPage as $paymentInstrument) {\n printf(\"Payment instrument #%s\\n\", $paymentInstrument->getId());\n }\n}\n\n// OR\n\n$paymentInstruments = $service->paymentInstruments()->getAll(filter: 'status:active;method:payment-card');\nforeach ($paymentInstruments as $paymentInstrument) {\n printf(\"Payment instrument #%s\\n\", $paymentInstrument->getId());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of payment instruments retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}},"schemaId":"schema_807","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1payment-instruments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_807","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_807"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/getpaymentinstrumentcollection"}],"panels":[]}]},"httpPath":"/payment-instruments"},{"label":"Create a payment instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-instruments/postpaymentinstrument","routeSlug":"/docs/dev-docs/api/payment-instruments/postpaymentinstrument","metadata":{"seo":{"title":"Create a payment instrument","description":"Creates a payment instrument. If the payment card, bank account, or alternative payment instrument already exists it is updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPaymentInstrument","name":"Create a payment instrument","isWebhook":false,"pointer":"/paths/~1payment-instruments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a payment instrument","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a payment instrument.\nIf the payment card, bank account, or alternative payment instrument already exists it is updated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_808"}},"schemaId":"schema_808","pointer":"/paths/~1payment-instruments/post/requestBody","description":"PaymentInstrument resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-instruments","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_808"}},"responseCodes":["201","303","401","403","422","429"],"pointer":"/payment-instruments","href":"payment-instruments/postpaymentinstrument","openApiOperationId":"PostPaymentInstrument","summary":"Create a payment instrument","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$paymentInstrumentForm = new Rebilly\\Entities\\CommonPaymentInstrument();\n$paymentInstrumentForm->setCustomerId('customerId');\n$paymentInstrumentForm->setPan('4111111111111111');\n$paymentInstrumentForm->setExpYear(2025);\n$paymentInstrumentForm->setExpMonth(8);\n$paymentInstrumentForm->setBillingAddress([\n 'firstName' => 'John',\n 'lastName' => 'Doe',\n 'organization' => 'Test LTD',\n 'address' => 'Test street 5',\n 'address2' => 'Test house 5',\n 'city' => 'New York',\n 'region' => 'Long Island',\n 'country' => 'US',\n 'postalCode' => '123456',\n 'emails' => [\n [\n 'label' => 'main',\n 'value' => 'johndoe@testemail.com',\n 'primary' => true,\n ],\n [\n 'label' => 'secondary',\n 'value' => 'otheremail@testemail.com',\n ],\n ],\n 'phoneNumbers' => [\n [\n 'label' => 'work',\n 'value' => '+123456789',\n 'primary' => true,\n ],\n [\n 'label' => 'home',\n 'value' => '+9874654321',\n ],\n ],\n]);\n\ntry {\n $paymentInstrument = $client->paymentInstruments()->create($paymentInstrumentForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n\n// Alternatively you can specify a payment token\n$paymentInstrumentForm = new Rebilly\\Entities\\CommonPaymentInstrument();\n$paymentInstrumentForm->setCustomerId('customerId');\n$paymentInstrumentForm->setToken('payment-token');\n\ntry {\n $paymentInstrument = $client->paymentInstruments()->create($paymentInstrumentForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the properties for the new payment card instrument\nconst data = {\n method: 'payment-card',\n pan: '4111111111111111',\n expYear: 2025,\n expMonth: 11,\n cvv: '123',\n billingAddress: {\n firstName: 'Johnny',\n lastName: 'Brown',\n emails: [{\n label: 'main',\n value: 'johnny+test@grr.la',\n primary: true\n }]\n },\n // the customer ID for which\n // we are adding a payment card instrument\n customerId: 'foobar-0001'\n};\n\nconst firstPaymentInstrument = await api.paymentInstruments.create({data});\n\n// alternatively you can specify a payment token\nconst tokenData = {\n token: 'payment-token',\n // the customer ID for which\n // we are adding a payment card instrument\n customerId: 'foobar-0001'\n};\n\nconst secondPaymentInstrument = await api.paymentInstruments.create({tokenData});\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$paymentInstrumentForm = new \\Rebilly\\Sdk\\Model\\PaymentCardCreatePlain();\n$paymentInstrumentForm->setCustomerId('customerId');\n$paymentInstrumentForm->setPan('4111111111111111');\n$paymentInstrumentForm->setExpYear(2025);\n$paymentInstrumentForm->setExpMonth(8);\n$paymentInstrumentForm->setBillingAddress([\n 'firstName' => 'John',\n 'lastName' => 'Doe',\n 'organization' => 'Test LTD',\n 'address' => 'Test street 5',\n 'address2' => 'Test house 5',\n 'city' => 'New York',\n 'region' => 'Long Island',\n 'country' => 'US',\n 'postalCode' => '123456',\n 'emails' => [\n [\n 'label' => 'main',\n 'value' => 'johndoe@testemail.com',\n 'primary' => true,\n ],\n [\n 'label' => 'secondary',\n 'value' => 'otheremail@testemail.com',\n ],\n ],\n 'phoneNumbers' => [\n [\n 'label' => 'work',\n 'value' => '+123456789',\n 'primary' => true,\n ],\n [\n 'label' => 'home',\n 'value' => '+9874654321',\n ],\n ],\n]);\n\ntry {\n $paymentInstrument = $service->paymentInstruments()->create($paymentInstrumentForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n\n// Alternatively you can specify a payment token\n$paymentInstrumentForm = new \\Rebilly\\Sdk\\Model\\PaymentInstrumentCreateToken();\n$paymentInstrumentForm->setCustomerId('customerId');\n$paymentInstrumentForm->setToken('payment-token');\n\ntry {\n $paymentInstrument = $service->paymentInstruments()->create($paymentInstrumentForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_808","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_808"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Payment instrument created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInstrument"}},"schemaId":"components/schemas/PaymentInstrument","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"303","description":"Payment instrument updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInstrument"}},"schemaId":"components/schemas/PaymentInstrument","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payment-instruments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PaymentInstrument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInstrument"}}},{"code":"303","schemaId":"components/schemas/PaymentInstrument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInstrument"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/postpaymentinstrument"}],"panels":[]}]},"httpPath":"/payment-instruments"},{"label":"Retrieve a payment instrument","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-instruments/getpaymentinstrument","routeSlug":"/docs/dev-docs/api/payment-instruments/getpaymentinstrument","metadata":{"seo":{"title":"Retrieve a payment instrument","description":"Retrieves a payment instrument with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPaymentInstrument","name":"Retrieve a payment instrument","isWebhook":false,"pointer":"/paths/~1payment-instruments~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment instrument","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a payment instrument with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payment-instruments~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment-instruments/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/payment-instruments/{id}","href":"payment-instruments/getpaymentinstrument","openApiOperationId":"GetPaymentInstrument","summary":"Retrieve a payment instrument","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$paymentInstrument = $client->paymentInstruments()->load('paymentInstrumentId');\n"},{"lang":"JavaScript","source":"const paymentInstrument = await api.paymentInstruments.get({id: 'payment-instrument-id'});\n\nconsole.log(paymentInstrument.fields.customerId);\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$paymentInstrument = $service->paymentInstruments()->get('paymentInstrumentId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment instrument retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInstrument"}},"schemaId":"components/schemas/PaymentInstrument"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1payment-instruments~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentInstrument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInstrument"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/getpaymentinstrument"}],"panels":[]}]},"httpPath":"/payment-instruments/{id}"},{"label":"Update payment instrument","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-instruments/patchpaymentinstrument","routeSlug":"/docs/dev-docs/api/payment-instruments/patchpaymentinstrument","metadata":{"seo":{"title":"Update payment instrument","description":"Updates the values of a payment instrument with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PatchPaymentInstrument","name":"Update payment instrument","isWebhook":false,"pointer":"/paths/~1payment-instruments~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update payment instrument","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the values of a payment instrument with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payment-instruments~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_809"}},"schemaId":"schema_809","pointer":"/paths/~1payment-instruments~1{id}/patch/requestBody","description":"PaymentInstrument resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/payment-instruments/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_809"}},"responseCodes":["200","401","403","404","422","429"],"pointer":"/payment-instruments/{id}","href":"payment-instruments/patchpaymentinstrument","openApiOperationId":"PatchPaymentInstrument","summary":"Update payment instrument","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$paymentInstrumentForm = new Rebilly\\Entities\\CommonPaymentInstrument();\n$paymentInstrumentForm->setCvv('123');\n$paymentInstrumentForm->setExpYear(2025);\n$paymentInstrumentForm->setExpMonth(12);\n$paymentInstrumentForm->setBillingAddress([\n 'firstName' => 'John',\n]);\n\ntry {\n $paymentInstrument = $client->paymentInstruments()->update('paymentInstrumentId', $paymentInstrumentForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n\n// Alternatively you can specify a partial token\n$paymentInstrumentForm = new Rebilly\\Entities\\CommonPaymentInstrument();\n$paymentInstrumentForm->setToken('partial-token');\n$paymentInstrumentForm->setBillingAddress([\n 'firstName' => 'John',\n]);\n\ntry {\n $paymentInstrument = $client->paymentInstruments()->update('paymentInstrumentId', $paymentInstrumentForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// payment instrument properties to be updated\nconst data = {\n cvv: '123',\n expMonth: 12,\n expYear: 2025,\n billingAddress: {\n firstName: 'John'\n }\n};\n\napi.paymentInstruments.patch({id: 'id-to-update', data});\n\n// alternatively you can specify a partial token\nconst tokenData = {\n token: 'partial-token',\n billingAddress: {\n firstName: 'John'\n },\n customFields: {\n foo: 'bar'\n }\n};\n\napi.paymentInstruments.patch({id: 'id-to-update', tokenData});\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$paymentInstrumentForm = new \\Rebilly\\Sdk\\Model\\PaymentCardUpdatePlain();\n$paymentInstrumentForm->setCvv('123');\n$paymentInstrumentForm->setExpYear(2025);\n$paymentInstrumentForm->setExpMonth(12);\n$paymentInstrumentForm->setBillingAddress([\n 'firstName' => 'John',\n]);\n\ntry {\n $paymentInstrument = $service->paymentInstruments()->update('paymentInstrumentId', $paymentInstrumentForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n\n// Alternatively you can specify a partial token\n$paymentInstrumentForm = new \\Rebilly\\Sdk\\Model\\PaymentInstrumentUpdateToken();\n$paymentInstrumentForm->setToken('partial-token');\n$paymentInstrumentForm->setBillingAddress([\n 'firstName' => 'John',\n]);\n\ntry {\n $paymentInstrument = $service->paymentInstruments()->update('paymentInstrumentId', $paymentInstrumentForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_809","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_809"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment instrument updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInstrument"}},"schemaId":"components/schemas/PaymentInstrument","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payment-instruments~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentInstrument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInstrument"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/patchpaymentinstrument"}],"panels":[]}]},"httpPath":"/payment-instruments/{id}"},{"label":"Deactivate a payment instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-instruments/postpaymentinstrumentdeactivation","routeSlug":"/docs/dev-docs/api/payment-instruments/postpaymentinstrumentdeactivation","metadata":{"seo":{"title":"Deactivate a payment instrument","description":"Deactivates a payment instrument with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPaymentInstrumentDeactivation","name":"Deactivate a payment instrument","isWebhook":false,"pointer":"/paths/~1payment-instruments~1{id}~1deactivation/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate a payment instrument","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deactivates a payment instrument with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payment-instruments~1{id}~1deactivation/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-instruments/{id}/deactivation","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","401","403","404","409","429"],"pointer":"/payment-instruments/{id}/deactivation","href":"payment-instruments/postpaymentinstrumentdeactivation","openApiOperationId":"PostPaymentInstrumentDeactivation","summary":"Deactivate a payment instrument","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$client->paymentInstruments()->deactivate('paymentInstrumentId');\n"},{"lang":"JavaScript","source":"const paymentInstrument = await api.paymentInstruments.deactivate({id: 'id-to-deactivate'});\n\nconsole.log(paymentInstrument.fields.status);\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$service->paymentInstruments()->deactivate('paymentInstrumentId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Payment instrument deactivated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInstrument"}},"schemaId":"components/schemas/PaymentInstrument","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payment-instruments~1{id}~1deactivation/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PaymentInstrument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInstrument"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/postpaymentinstrumentdeactivation"}],"panels":[]}]},"httpPath":"/payment-instruments/{id}/deactivation"},{"label":"Verify name on a payment instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-instruments/postpaymentinstrumentnameinquiry","routeSlug":"/docs/dev-docs/api/payment-instruments/postpaymentinstrumentnameinquiry","metadata":{"seo":{"title":"Verify name on a payment instrument","description":"Performs a name check inquiry on a payment instrument. Use this operation to confirm the name that is associated with a payment instrument. This operation supports payment cards only, using VISA ANI requests through Worldpay."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPaymentInstrumentNameInquiry","name":"Verify name on a payment instrument","isWebhook":false,"pointer":"/paths/~1payment-instruments~1{id}~1name-inquiry/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify name on a payment instrument","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Performs a name check inquiry on a payment instrument.\nUse this operation to confirm the name that is associated with a payment instrument.\nThis operation supports payment cards only, using VISA ANI requests through Worldpay."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payment-instruments~1{id}~1name-inquiry/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentInstrumentNameInquiry"}},"schemaId":"components/schemas/PaymentInstrumentNameInquiry","pointer":"/paths/~1payment-instruments~1{id}~1name-inquiry/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment-instruments/{id}/name-inquiry","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentInstrumentNameInquiry"}},"responseCodes":["200","401","403","404","409","422","429"],"pointer":"/payment-instruments/{id}/name-inquiry","href":"payment-instruments/postpaymentinstrumentnameinquiry","openApiOperationId":"PostPaymentInstrumentNameInquiry","summary":"Verify name on a payment instrument","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/PaymentInstrumentNameInquiry","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentInstrumentNameInquiry"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment instrument name inquiry performed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInstrumentNameInquiry"}},"schemaId":"components/schemas/PaymentInstrumentNameInquiry","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payment-instruments~1{id}~1name-inquiry/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentInstrumentNameInquiry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInstrumentNameInquiry"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/postpaymentinstrumentnameinquiry"}],"panels":[]}]},"httpPath":"/payment-instruments/{id}/name-inquiry"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Payment card created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/payment-instruments/payment-card-created","routeSlug":"/docs/dev-docs/api/payment-instruments/payment-card-created","metadata":{"seo":{"title":"Payment card created","description":"Payment card created"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"payment-card-created","name":"Payment card created","isWebhook":true,"pointer":"/paths/payment-card-created/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment card created","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_810"}},"schemaId":"schema_810","pointer":"/paths/payment-card-created/post/requestBody","description":"Payload of payment card-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"payment-card-created","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_810"}},"responseCodes":["2xx"],"pointer":"payment-card-created","href":"payment-instruments/payment-card-created","openApiOperationId":"payment-card-created","summary":"Payment card created","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_810","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_810"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/payment-card-created/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/payment-card-created"}],"panels":[]}]},"httpPath":"payment-card-created"},{"label":"Payment card expiration reminder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/payment-instruments/payment-card-expiration-reminder","routeSlug":"/docs/dev-docs/api/payment-instruments/payment-card-expiration-reminder","metadata":{"seo":{"title":"Payment card expiration reminder","description":"Payment card expiration reminder"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"payment-card-expiration-reminder","name":"Payment card expiration reminder","isWebhook":true,"pointer":"/paths/payment-card-expiration-reminder/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment card expiration reminder","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_810"}},"schemaId":"schema_810","pointer":"/paths/payment-card-expiration-reminder/post/requestBody","description":"Payload of payment card-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"payment-card-expiration-reminder","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_810"}},"responseCodes":["2xx"],"pointer":"payment-card-expiration-reminder","href":"payment-instruments/payment-card-expiration-reminder","openApiOperationId":"payment-card-expiration-reminder","summary":"Payment card expiration reminder","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_810","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_810"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/payment-card-expiration-reminder/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/payment-card-expiration-reminder"}],"panels":[]}]},"httpPath":"payment-card-expiration-reminder"},{"label":"Payment card expired","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/payment-instruments/payment-card-expired","routeSlug":"/docs/dev-docs/api/payment-instruments/payment-card-expired","metadata":{"seo":{"title":"Payment card expired","description":"Payment card expired"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"payment-card-expired","name":"Payment card expired","isWebhook":true,"pointer":"/paths/payment-card-expired/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment card expired","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_810"}},"schemaId":"schema_810","pointer":"/paths/payment-card-expired/post/requestBody","description":"Payload of payment card-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"payment-card-expired","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_810"}},"responseCodes":["2xx"],"pointer":"payment-card-expired","href":"payment-instruments/payment-card-expired","openApiOperationId":"payment-card-expired","summary":"Payment card expired","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_810","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_810"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/payment-card-expired/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/payment-card-expired"}],"panels":[]}]},"httpPath":"payment-card-expired"},{"label":"Payment instrument modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/payment-instruments/payment-instrument-modified","routeSlug":"/docs/dev-docs/api/payment-instruments/payment-instrument-modified","metadata":{"seo":{"title":"Payment instrument modified","description":"Payment instrument modified"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"payment-instrument-modified","name":"Payment instrument modified","isWebhook":true,"pointer":"/paths/payment-instrument-modified/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment instrument modified","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_811"}},"schemaId":"schema_811","pointer":"/paths/payment-instrument-modified/post/requestBody","description":"Payload of payment instrument-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"payment-instrument-modified","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_811"}},"responseCodes":["2xx"],"pointer":"payment-instrument-modified","href":"payment-instruments/payment-instrument-modified","openApiOperationId":"payment-instrument-modified","summary":"Payment instrument modified","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_811","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_811"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/payment-instrument-modified/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/payment-instrument-modified"}],"panels":[]}]},"httpPath":"payment-instrument-modified"}],"content":{"contentType":"group","meta":{"name":"Payment instruments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment instruments","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these operations to manage payment instruments."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment instrument is a term which describes any means of making a digital payment, such as:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credit cards, debit cards, direct debits, payment service providers, and digital wallets."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information on payment instruments, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/concepts/#payment-instruments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment instruments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payment-instruments","summary":"Retrieve payment instruments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-instruments/getpaymentinstrumentcollection","deprecated":false},{"title":"/payment-instruments","summary":"Create a payment instrument","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-instruments/postpaymentinstrument","deprecated":false},{"title":"/payment-instruments/{id}","summary":"Retrieve a payment instrument","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-instruments/getpaymentinstrument","deprecated":false},{"title":"/payment-instruments/{id}","summary":"Update payment instrument","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/payment-instruments/patchpaymentinstrument","deprecated":false},{"title":"/payment-instruments/{id}/deactivation","summary":"Deactivate a payment instrument","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-instruments/postpaymentinstrumentdeactivation","deprecated":false},{"title":"/payment-instruments/{id}/name-inquiry","summary":"Verify name on a payment instrument","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-instruments/postpaymentinstrumentnameinquiry","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"payment-card-created","summary":"Payment card created","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-instruments/payment-card-created","deprecated":false},{"title":"payment-card-expiration-reminder","summary":"Payment card expiration reminder","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-instruments/payment-card-expiration-reminder","deprecated":false},{"title":"payment-card-expired","summary":"Payment card expired","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-instruments/payment-card-expired","deprecated":false},{"title":"payment-instrument-modified","summary":"Payment instrument modified","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-instruments/payment-instrument-modified","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment tokens","link":"/docs/dev-docs/api/payment-tokens","routeSlug":"/docs/dev-docs/api/payment-tokens","items":[{"label":"Create a payment token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-tokens/posttoken","routeSlug":"/docs/dev-docs/api/payment-tokens/posttoken","metadata":{"seo":{"title":"Create a payment token","description":"Creates a payment token which can be exchanged into a payment instrument.FramePay is the recommended way to create a payment token because it minimizes PCI DSS compliance.Once a payment token is created, it can only be used once."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostToken","name":"Create a payment token","isWebhook":false,"pointer":"/paths/~1tokens/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a payment token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a payment token which can be exchanged into a payment instrument."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.rebilly.com/docs/developer-docs/framepay/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FramePay"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the recommended way to create a payment token because it minimizes PCI DSS compliance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once a payment token is created, it can only be used once."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment token expires upon first use or within 30 minutes of the token creation, whichever comes first."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"PublishableApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This authentication method is applicable to specific operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a publishable API key, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/api-keys/postapikey"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an API key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompositeToken"}},"schemaId":"components/schemas/CompositeToken","pointer":"/paths/~1tokens/post/requestBody","description":"Payment token resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tokens","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"PublishableApiKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]},{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompositeToken"}},"responseCodes":["201","401","403","422","429"],"pointer":"/tokens","href":"payment-tokens/posttoken","openApiOperationId":"PostToken","summary":"Create a payment token","securityGroups":[{"PublishableApiKey":[]},{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$paymentCardTokenForm = new Rebilly\\Entities\\PaymentCardToken();\n$paymentCardTokenForm->setBillingAddress([\n 'firstName' => 'John',\n 'lastName' => 'Doe',\n 'organization' => 'Test LTD',\n 'address' => 'Test street 5',\n 'address2' => 'Test house 5',\n 'city' => 'New York',\n 'region' => 'Long Island',\n 'country' => 'US',\n 'postalCode' => '123456',\n 'emails' => [\n [\n 'label' => 'main',\n 'value' => 'johndoe@testemail.com',\n 'primary' => true,\n ],\n [\n 'label' => 'secondary',\n 'value' => 'otheremail@testemail.com',\n ],\n ],\n 'phoneNumbers' => [\n [\n 'label' => 'work',\n 'value' => '+123456789',\n 'primary' => true,\n ],\n [\n 'label' => 'home',\n 'value' => '+9874654321',\n ],\n ],\n]);\n\n$paymentInstrumentForm = new Entities\\PaymentInstruments\\PaymentCardPaymentInstrument();\n$paymentInstrumentForm->setPan('4111111111111111');\n$paymentInstrumentForm->setExpYear(2025);\n$paymentInstrumentForm->setExpMonth(8);\n$paymentInstrumentForm->setCvv(123);\n\n$paymentCardTokenForm->setPaymentInstrument($paymentInstrumentForm);\n\ntry {\n $paymentCardToken = $client->paymentCardTokens()->create($paymentCardTokenForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the properties for the new payment token\nconst data = {\n method: 'payment-card',\n paymentInstrument: {\n pan: '4111111111111111',\n expYear: 2022,\n expMonth: 12,\n cvv: '123'\n },\n billingAddress: {\n firstName: 'Johnny',\n lastName: 'Brown',\n emails: [{\n label: 'main',\n value: 'johnny+test@grr.la',\n primary: true\n }]\n }\n};\n\nconst token = await api.paymentTokens.create({data});\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$paymentCardTokenForm = new \\Rebilly\\Sdk\\Model\\PaymentCardToken();\n$paymentCardTokenForm->setBillingAddress([\n 'firstName' => 'John',\n 'lastName' => 'Doe',\n 'organization' => 'Test LTD',\n 'address' => 'Test street 5',\n 'address2' => 'Test house 5',\n 'city' => 'New York',\n 'region' => 'Long Island',\n 'country' => 'US',\n 'postalCode' => '123456',\n 'emails' => [\n [\n 'label' => 'main',\n 'value' => 'johndoe@testemail.com',\n 'primary' => true,\n ],\n [\n 'label' => 'secondary',\n 'value' => 'otheremail@testemail.com',\n ],\n ],\n 'phoneNumbers' => [\n [\n 'label' => 'work',\n 'value' => '+123456789',\n 'primary' => true,\n ],\n [\n 'label' => 'home',\n 'value' => '+9874654321',\n ],\n ],\n]);\n\n$paymentInstrumentForm = new \\Rebilly\\Sdk\\Model\\PaymentCardTokenPaymentInstrument();\n$paymentInstrumentForm->setPan('4111111111111111');\n$paymentInstrumentForm->setExpYear(2025);\n$paymentInstrumentForm->setExpMonth(8);\n$paymentInstrumentForm->setCvv('123');\n\n$paymentCardTokenForm->setPaymentInstrument($paymentInstrumentForm);\n\ntry {\n $paymentCardToken = $service->paymentTokens()->create($paymentCardTokenForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/CompositeToken","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompositeToken"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Token created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompositeToken"}},"schemaId":"components/schemas/CompositeToken","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1tokens/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CompositeToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompositeToken"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-tokens/posttoken"}],"panels":[]}]},"httpPath":"/tokens"},{"label":"Retrieve tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-tokens/gettokencollection","routeSlug":"/docs/dev-docs/api/payment-tokens/gettokencollection","metadata":{"seo":{"title":"Retrieve tokens","description":"Retrieve a list of tokens."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTokenCollection","name":"Retrieve tokens","isWebhook":false,"pointer":"/paths/~1tokens/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve tokens","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of tokens."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."}],"pointer":"/paths/~1tokens/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tokens","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/tokens","href":"payment-tokens/gettokencollection","openApiOperationId":"GetTokenCollection","summary":"Retrieve tokens","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$paymentCardTokens = $client->paymentCardTokens()->search([\n 'filter' => 'token:string',\n]);\n"},{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.paymentTokens.getAll();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100};\nconst secondCollection = await api.paymentTokens.getAll(params);\n\n// access the collection items, each item is a Token\nsecondCollection.items.forEach(paymentToken => console.log(paymentToken.fields.id));\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$paymentCardTokensPaginator = $service->paymentTokens()->getAllPaginator(limit: 5);\nforeach ($paymentCardTokensPaginator as $paymentCardTokensPage) {\n printf(\"Payment card tokens page %d/%d\\n\", $paymentCardTokensPaginator->key() + 1, $paymentCardTokensPaginator->count());\n foreach ($paymentCardTokensPage as $paymentCardToken) {\n printf(\"Payment card token #%s\\n\", $paymentCardToken->getId());\n }\n}\n\n// OR\n\n$paymentCardTokens = $service->paymentTokens()->getAll();\nforeach ($paymentCardTokens as $paymentCardToken) {\n printf(\"Payment card token #%s\\n\", $paymentCardToken->getId());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of tokens retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_812"}},"schemaId":"schema_812","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1tokens/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_812","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_812"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-tokens/gettokencollection"}],"panels":[]}]},"httpPath":"/tokens"},{"label":"Retrieve a token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-tokens/gettoken","routeSlug":"/docs/dev-docs/api/payment-tokens/gettoken","metadata":{"seo":{"title":"Retrieve a token","description":"Retrieves a token with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetToken","name":"Retrieve a token","isWebhook":false,"pointer":"/paths/~1tokens~1{token}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a token with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"PublishableApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This authentication method is applicable to specific operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a publishable API key, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/api-keys/postapikey"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an API key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token","in":"path","schemaId":"schema_782","description":"ID of the token.","required":true}],"pointer":"/paths/~1tokens~1{token}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tokens/{token}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"token","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"PublishableApiKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/tokens/{token}","href":"payment-tokens/gettoken","openApiOperationId":"GetToken","summary":"Retrieve a token"},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$paymentCardToken = $client->paymentCardTokens()->load('tokenId');\n"},{"lang":"JavaScript","source":"const paymentToken = await api.paymentTokens.get({id: 'foobar-001'});\nconsole.log(paymentToken.fields.method);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$paymentCardToken = $service->paymentTokens()->get('tokenId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Token retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompositeToken"}},"schemaId":"components/schemas/CompositeToken"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1tokens~1{token}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompositeToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompositeToken"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-tokens/gettoken"}],"panels":[]}]},"httpPath":"/tokens/{token}"},{"label":"Validate a digital wallet session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/payment-tokens/postdigitalwalletvalidation","routeSlug":"/docs/dev-docs/api/payment-tokens/postdigitalwalletvalidation","metadata":{"seo":{"title":"Validate a digital wallet session","description":"Validates a digital wallet session."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostDigitalWalletValidation","name":"Validate a digital wallet session","isWebhook":false,"pointer":"/paths/~1digital-wallets~1validation/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate a digital wallet session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validates a digital wallet session."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.rebilly.com/docs/developer-docs/framepay/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FramePay"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to validate a digital wallet session."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"PublishableApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This authentication method is applicable to specific operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a publishable API key, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/api-keys/postapikey"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an API key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DigitalWalletValidation"}},"schemaId":"components/schemas/DigitalWalletValidation","pointer":"/paths/~1digital-wallets~1validation/post/requestBody","description":"Digital wallet validation request."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/digital-wallets/validation","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"PublishableApiKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]},{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DigitalWalletValidation"}},"responseCodes":["201","401","403","422","429"],"pointer":"/digital-wallets/validation","href":"payment-tokens/postdigitalwalletvalidation","openApiOperationId":"PostDigitalWalletValidation","summary":"Validate a digital wallet session","securityGroups":[{"PublishableApiKey":[]},{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/DigitalWalletValidation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DigitalWalletValidation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Digital wallet validation complete.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DigitalWalletValidation"}},"schemaId":"components/schemas/DigitalWalletValidation","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1digital-wallets~1validation/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/DigitalWalletValidation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DigitalWalletValidation"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-tokens/postdigitalwalletvalidation"}],"panels":[]}]},"httpPath":"/digital-wallets/validation"}],"content":{"contentType":"group","meta":{"name":"Payment tokens"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment tokens","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use payment tokens to reduce the scope of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/pci-compliance/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PCI DSS compliance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment token can be made using a different authentication scheme (public key authentication), which enables you to create a payment token directly from the browser."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This bypasses the need to send sensitive cardholder info to your servers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend using this with the FramePay library, which helps you integrate a form into this API resource and create payment tokens."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tokens","summary":"Create a payment token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-tokens/posttoken","deprecated":false},{"title":"/tokens","summary":"Retrieve tokens","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-tokens/gettokencollection","deprecated":false},{"title":"/tokens/{token}","summary":"Retrieve a token","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-tokens/gettoken","deprecated":false},{"title":"/digital-wallets/validation","summary":"Validate a digital wallet session","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-tokens/postdigitalwalletvalidation","deprecated":false}]}]}]}]}},{"type":"separator","label":"Payments","content":null},{"type":"group","label":"Transactions","link":"/docs/dev-docs/api/transactions","routeSlug":"/docs/dev-docs/api/transactions","items":[{"label":"Ready to pay","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postreadytopay","routeSlug":"/docs/dev-docs/api/transactions/postreadytopay","metadata":{"seo":{"title":"Ready to pay","description":"Retrieves available payment methods for a specific transaction or purchase."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostReadyToPay","name":"Ready to pay","isWebhook":false,"pointer":"/paths/~1ready-to-pay/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ready to pay","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves available payment methods for a specific transaction or purchase."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order in which the payment methods are displayed to the customer should be the same as the order in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of payment methods is generated from available gateway accounts and the last matched "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adjust-ready-to-pay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready-to-pay-requested"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no rules match for the specific request, all methods supported by the gateway accounts are sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To invert this behavior, place an all matching rule at the end of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready-to-pay-requested"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event in the rules engine,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and include an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adjust-ready-to-pay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/rules#operation/PutEventRule"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update event rules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/gateway-accounts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway accounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostReadyToPay"}},"schemaId":"components/schemas/PostReadyToPay","pointer":"/paths/~1ready-to-pay/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ready-to-pay","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostReadyToPay"}},"responseCodes":["200","401","403","422","429"],"pointer":"/ready-to-pay","href":"transactions/postreadytopay","openApiOperationId":"PostReadyToPay","summary":"Ready to pay","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$readyToPayForm = new Rebilly\\Entities\\ReadyToPay();\n$readyToPayForm->setCurrency('USD');\n$readyToPayForm->setAmount(10);\n$readyToPayForm->setWebsiteId('websiteId');\n$readyToPayForm->setCustomerId('customerId');\n\n$riskMetadata = new Rebilly\\Entities\\RiskMetadata();\n$riskMetadata->setFingerprint('fingerprint');\n$readyToPayForm->setRiskMetadata($riskMetadata);\n\ntry {\n $transaction = $client->transactions()->create($readyToPayForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$readyToPayForm = new \\Rebilly\\Sdk\\Model\\ReadyToPayAmount();\n$readyToPayForm->setCurrency('USD');\n$readyToPayForm->setAmount(10);\n$readyToPayForm->setWebsiteId('websiteId');\n$readyToPayForm->setCustomerId('customerId');\n\n$riskMetadata = new \\Rebilly\\Sdk\\Model\\RiskMetadata();\n$riskMetadata->setFingerprint('fingerprint');\n$readyToPayForm->setRiskMetadata($riskMetadata);\n\ntry {\n $transactions = $service->purchase()->readyToPay($readyToPayForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/PostReadyToPay","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostReadyToPay"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment methods retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_813"}},"schemaId":"schema_813","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1ready-to-pay/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_813","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_813"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/postreadytopay"}],"panels":[]}]},"httpPath":"/ready-to-pay"},{"label":"Create a transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/posttransaction","routeSlug":"/docs/dev-docs/api/transactions/posttransaction","metadata":{"seo":{"title":"Create a transaction","description":"Creates a transaction of type sale, authorize or setup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostTransaction","name":"Create a transaction","isWebhook":false,"pointer":"/paths/~1transactions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a transaction of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"setup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this operation for the following transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"transactions/posttransaction/request/real-time-decision-and-response","deepLinkHash":"/transactions/posttransaction#transactions/posttransaction/request/real-time-decision-and-response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real-time decision and response"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In this transaction, you send a request and inspect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the response for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"declined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"transactions/posttransaction/request/user-approvalinteraction-required","deepLinkHash":"/transactions/posttransaction#transactions/posttransaction/request/user-approvalinteraction-required"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User approval/interaction required"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In this transaction, user approval is required to complete the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User approval generally requires the user to interact with a third party,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and is common in many transactions for alternative methods."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, PayPal requires user permission to complete a payment or to accept a billing agreement."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment cards may also require user approval for 3D secure authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If approval is required, you receive a response with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waiting-approval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the response has a link for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approvalUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approvalUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in an iframe or in a pop. A pop is a better workflow for mobile devices."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1transactions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_814"}},"schemaId":"schema_814","pointer":"/paths/~1transactions/post/requestBody","description":"Transaction resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transactions","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_814"}},"responseCodes":["201","401","403","409","422","429"],"pointer":"/transactions","href":"transactions/posttransaction","openApiOperationId":"PostTransaction","summary":"Create a transaction","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$transactionForm = new Rebilly\\Entities\\Transaction();\n$transactionForm->setType('sale');\n$transactionForm->setCustomerId('customerId');\n$transactionForm->setWebsiteId('websiteId');\n$transactionForm->setCurrency('USD');\n$transactionForm->setAmount(1);\n\n$paymentInstruction = new Rebilly\\Entities\\Transactions\\PaymentInstructions\\PaymentTokenInstruction();\n$paymentInstruction->setToken('payment-token');\n$transactionForm->setPaymentInstruction($paymentInstruction);\n\n$transactionForm->setBillingAddress([\n 'firstName' => 'John',\n 'lastName' => 'Doe',\n 'organization' => 'Test LTD',\n 'address' => 'Test street 5',\n 'address2' => 'Test house 5',\n 'city' => 'New York',\n 'region' => 'Long Island',\n 'country' => 'US',\n 'postalCode' => '123456',\n 'emails' => [\n [\n 'label' => 'main',\n 'value' => 'johndoe@testemail.com',\n 'primary' => true,\n ],\n [\n 'label' => 'secondary',\n 'value' => 'otheremail@testemail.com',\n ],\n ],\n 'phoneNumbers' => [\n [\n 'label' => 'work',\n 'value' => '+123456789',\n 'primary' => true,\n ],\n [\n 'label' => 'home',\n 'value' => '+9874654321',\n ],\n ],\n 'dob' => '2000-06-01',\n]);\n\ntry {\n $transaction = $client->transactions()->create($transactionForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the properties for the new transaction\nconst data = {\n customerId: 'foobar-0001',\n type: 'sale',\n websiteId: 'my-main-website',\n paymentInstrument: {\n method: 'payment-card',\n paymentCardId: 'my-payment-card-id',\n gatewayAccountId: 'my-gateway-account-id'\n },\n currency: 'USD',\n amount: 12.99,\n description: 'manual transaction',\n};\n\nconst transaction = await api.transactions.create({data});\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$transactionForm = new \\Rebilly\\Sdk\\Model\\PostTransactionRequest([\n 'type' => 'sale',\n 'amount' => 1,\n]);\n$transactionForm->setCustomerId('customerId');\n$transactionForm->setWebsiteId('websiteId');\n$transactionForm->setCurrency('USD');\n\n$paymentInstruction = new \\Rebilly\\Sdk\\Model\\PaymentInstructionToken();\n$paymentInstruction->setToken('payment-token');\n$transactionForm->setPaymentInstruction($paymentInstruction);\n\n$transactionForm->setBillingAddress([\n 'firstName' => 'John',\n 'lastName' => 'Doe',\n 'organization' => 'Test LTD',\n 'address' => 'Test street 5',\n 'address2' => 'Test house 5',\n 'city' => 'New York',\n 'region' => 'Long Island',\n 'country' => 'US',\n 'postalCode' => '123456',\n 'emails' => [\n [\n 'label' => 'main',\n 'value' => 'johndoe@testemail.com',\n 'primary' => true,\n ],\n [\n 'label' => 'secondary',\n 'value' => 'otheremail@testemail.com',\n ],\n ],\n 'phoneNumbers' => [\n [\n 'label' => 'work',\n 'value' => '+123456789',\n 'primary' => true,\n ],\n [\n 'label' => 'home',\n 'value' => '+9874654321',\n ],\n ],\n 'dob' => '2000-06-01',\n]);\n\ntry {\n $transaction = $service->transactions()->create($transactionForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_814","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_814"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Transaction created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction"}},"schemaId":"components/schemas/Transaction","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1transactions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Transaction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/posttransaction"}],"panels":[]}]},"httpPath":"/transactions"},{"label":"Retrieve transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/gettransactioncollection","routeSlug":"/docs/dev-docs/api/transactions/gettransactioncollection","metadata":{"seo":{"title":"Retrieve transactions","description":"Retrieves a list of transactions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTransactionCollection","name":"Retrieve transactions","isWebhook":false,"pointer":"/paths/~1transactions/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of transactions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"q","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","422"],"pointer":"/transactions","href":"transactions/gettransactioncollection","openApiOperationId":"GetTransactionCollection","summary":"Retrieve transactions","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$transactions = $client->transactions()->search([\n 'filter' => 'result:approved',\n]);\n"},{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.transactions.getAll();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100, sort: '-createdTime'};\nconst secondCollection = await api.transactions.getAll(params);\n\n// access the collection items, each item is a Transaction\nsecondCollection.items.forEach(transaction => console.log(transaction.fields.type));\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$transactionsPaginator = $service->transactions()->getAllPaginator(limit: 5, filter: 'result:approved');\nforeach ($transactionsPaginator as $transactionsPage) {\n printf(\"Transactions page %d/%d\\n\", $transactionsPaginator->key() + 1, $transactionsPaginator->count());\n foreach ($transactionsPage as $transaction) {\n printf(\"Transaction #%s (%s): %s\\n\", $transaction->getId(), $transaction->getStatus(), $transaction->getDescription());\n }\n}\n\n// OR\n\n$transactions = $service->transactions()->getAll(filter: 'result:approved');\nforeach ($transactions as $transaction) {\n printf(\"Transaction #%s (%s): %s\\n\", $transaction->getId(), $transaction->getStatus(), $transaction->getDescription());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of transactions retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_815"}},"schemaId":"schema_815","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"}],"pointer":"/paths/~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_815","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_815"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/gettransactioncollection"}],"panels":[]}]},"httpPath":"/transactions"},{"label":"Retrieve a transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/gettransaction","routeSlug":"/docs/dev-docs/api/transactions/gettransaction","metadata":{"seo":{"title":"Retrieve a transaction","description":"Retrieves a transaction with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTransaction","name":"Retrieve a transaction","isWebhook":false,"pointer":"/paths/~1transactions~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a transaction with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1transactions~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1transactions~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_816","description":"Type of response media."}],"pointer":"/paths/~1transactions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[{"name":"Accept","in":"header","schemaId":"schema_816"}],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/transactions/{id}","href":"transactions/gettransaction","openApiOperationId":"GetTransaction","summary":"Retrieve a transaction","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$transaction = $client->transactions()->load('transactionId');\n"},{"lang":"JavaScript","source":"const transaction = await api.transactions.get({id: 'foobar-001'});\nconsole.log(transaction.fields.billingAddress.firstName);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$transaction = $service->transactions()->get('transactionId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction retrieved.","mediaType":"application/json","mediaTypes":["application/json","application/pdf"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction"},"application/pdf":{"schemaId":"schema_817"}},"schemaId":"components/schemas/Transaction"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1transactions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transaction","mediaTypes":["application/json","application/pdf"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction"},"application/pdf":{"schemaId":"schema_817"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/gettransaction"}],"panels":[]}]},"httpPath":"/transactions/{id}"},{"label":"Update a transaction","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/patchtransaction","routeSlug":"/docs/dev-docs/api/transactions/patchtransaction","metadata":{"seo":{"title":"Update a transaction","description":"Updates the custom fields of a transaction with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PatchTransaction","name":"Update a transaction","isWebhook":false,"pointer":"/paths/~1transactions~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the custom fields of a transaction with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1transactions~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_818"}},"schemaId":"schema_818","pointer":"/paths/~1transactions~1{id}/patch/requestBody","description":"Use the patch transaction request to modify custom fields."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/transactions/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_818"}},"responseCodes":["200","401","403","404","429"],"pointer":"/transactions/{id}","href":"transactions/patchtransaction","openApiOperationId":"PatchTransaction","summary":"Update a transaction","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"try {\n $transaction = $client->transactions()->patch($transactionId, $data);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the custom fields to update for the transaction\nconst data = {\n customFields: {\n 'myCustomField': 'myCustomData',\n 'myOtherField': 'myOtherData', \n }\n};\n\nconst transaction = await api.transactions.patch({id: 'my-transaction-id', data});\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$transactionForm = new \\Rebilly\\Sdk\\Model\\PatchTransactionRequest();\n$transactionForm->setCustomFields([\n [\n 'name' => 'customField',\n 'value' => 'customValue',\n ],\n]);\n\ntry {\n $transaction = $service->transactions()->patch('transactionId', $transactionForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_818","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_818"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction"}},"schemaId":"components/schemas/Transaction","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1transactions~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transaction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/patchtransaction"}],"panels":[]}]},"httpPath":"/transactions/{id}"},{"label":"Create a credit transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayout","routeSlug":"/docs/dev-docs/api/transactions/postpayout","metadata":{"seo":{"title":"Create a credit transaction","description":"Creates a transaction of type credit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPayout","name":"Create a credit transaction","isWebhook":false,"pointer":"/paths/~1payouts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a credit transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a transaction of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_819"}},"schemaId":"schema_819","pointer":"/paths/~1payouts/post/requestBody","description":"Transaction resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payouts","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_819"}},"responseCodes":["201","401","403","409","422","429"],"pointer":"/payouts","href":"transactions/postpayout","openApiOperationId":"PostPayout","summary":"Create a credit transaction","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_819","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_819"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Transaction created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction"}},"schemaId":"components/schemas/Transaction","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payouts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Transaction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/postpayout"}],"panels":[]}]},"httpPath":"/payouts"},{"label":"Query a transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/posttransactionquery","routeSlug":"/docs/dev-docs/api/transactions/posttransactionquery","metadata":{"seo":{"title":"Query a transaction","description":"Queries a transaction with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostTransactionQuery","name":"Query a transaction","isWebhook":false,"pointer":"/paths/~1transactions~1{id}~1query/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query a transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Queries a transaction with a specified ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query interacts with the related gateway account to obtain the result, amount, and currency."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If after analysis, the transaction must be updated, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../PostTransactionUpdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a transaction status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1transactions~1{id}~1query/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transactions/{id}/query","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","401","403","404","429"],"pointer":"/transactions/{id}/query","href":"transactions/posttransactionquery","openApiOperationId":"PostTransactionQuery","summary":"Query a transaction","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Transaction queried.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionQuery"}},"schemaId":"components/schemas/TransactionQuery","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1transactions~1{id}~1query/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TransactionQuery","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionQuery"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/posttransactionquery"}],"panels":[]}]},"httpPath":"/transactions/{id}/query"},{"label":"Update a transaction status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/posttransactionupdate","routeSlug":"/docs/dev-docs/api/transactions/posttransactionupdate","metadata":{"seo":{"title":"Update a transaction status","description":"Updates the status of a transaction with a specified ID to completed,with a specified result and optional currency and amount values."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostTransactionUpdate","name":"Update a transaction status","isWebhook":false,"pointer":"/paths/~1transactions~1{id}~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a transaction status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the status of a transaction with a specified ID to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with a specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and optional currency and amount values."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1transactions~1{id}~1update/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionUpdate"}},"schemaId":"components/schemas/TransactionUpdate","pointer":"/paths/~1transactions~1{id}~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transactions/{id}/update","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransactionUpdate"}},"responseCodes":["200","401","403","404","429"],"pointer":"/transactions/{id}/update","href":"transactions/posttransactionupdate","openApiOperationId":"PostTransactionUpdate","summary":"Update a transaction status","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/TransactionUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction"}},"schemaId":"components/schemas/Transaction","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1transactions~1{id}~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transaction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/posttransactionupdate"}],"panels":[]}]},"httpPath":"/transactions/{id}/update"},{"label":"Refund a transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/posttransactionrefund","routeSlug":"/docs/dev-docs/api/transactions/posttransactionrefund","metadata":{"seo":{"title":"Refund a transaction","description":"Refunds a transaction with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostTransactionRefund","name":"Refund a transaction","isWebhook":false,"pointer":"/paths/~1transactions~1{id}~1refund/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refund a transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Refunds a transaction with a specified ID.\n\nThe refund is in the same currency as the original transaction."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1transactions~1{id}~1refund/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1transactions~1{id}~1refund/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionRefund"}},"schemaId":"components/schemas/TransactionRefund","pointer":"/paths/~1transactions~1{id}~1refund/post/requestBody","description":"Transaction resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transactions/{id}/refund","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransactionRefund"}},"responseCodes":["201","401","403","404","429"],"pointer":"/transactions/{id}/refund","href":"transactions/posttransactionrefund","openApiOperationId":"PostTransactionRefund","summary":"Refund a transaction","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$transaction = $client->transactions()->refund('transactionId', 1.99);\n"},{"lang":"JavaScript","source":"// define the refund amount\nconst data = {\n amount: 12.99\n};\n\nconst refund = await api.transactions.switch({id: 'my-transaction-id', data});\nconsole.log(refund.fields.status);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$transactionRefund = new \\Rebilly\\Sdk\\Model\\TransactionRefund();\n$transactionRefund->setAmount(1.99);\n\n$transaction = $service->transactions()->refund('transactionId', $transactionRefund);"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/TransactionRefund","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionRefund"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Transaction refunded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction"}},"schemaId":"components/schemas/Transaction","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1transactions~1{id}~1refund/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Transaction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/posttransactionrefund"}],"panels":[]}]},"httpPath":"/transactions/{id}/refund"},{"label":"Retrieve payout requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/getpayoutrequestcollection","routeSlug":"/docs/dev-docs/api/transactions/getpayoutrequestcollection","metadata":{"seo":{"title":"Retrieve payout requests","description":"Retrieves a list of payout requests."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPayoutRequestCollection","name":"Retrieve payout requests","isWebhook":false,"pointer":"/paths/~1payout-requests/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve payout requests","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a list of payout requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"websiteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blockReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"splitReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1payout-requests/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payout-requests","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/payout-requests","href":"transactions/getpayoutrequestcollection","openApiOperationId":"GetPayoutRequestCollection","summary":"Retrieve payout requests","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of payout requests retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_820"}},"schemaId":"schema_820","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1payout-requests/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_820","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_820"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/getpayoutrequestcollection"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests"},{"label":"Create a payout request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequest","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequest","metadata":{"seo":{"title":"Create a payout request","description":"Creates a payout request.In the response, the selectPaymentInstrumentUrl field is used to redirect the customer to select a preferred payment instrument.After a payment instrument is selected, the customer is redirected to the selectedPaymentInstrumentRedirectUrl value."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPayoutRequest","name":"Create a payout request","isWebhook":false,"pointer":"/paths/~1payout-requests/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a payout request","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a payout request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the response, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selectPaymentInstrumentUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is used to redirect the customer to select a preferred payment instrument."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After a payment instrument is selected, the customer is redirected to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selectedPaymentInstrumentRedirectUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The selected payment gateway must be configured to support payout requests."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/gateway-accounts/getgatewayaccountcollection#gateway-accounts/getgatewayaccountcollection/t=response&c=200&path=&d=0/readytopayoutinstruction"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"readyToPayoutInstruction"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}},"schemaId":"components/schemas/PayoutRequest","pointer":"/paths/~1payout-requests/post/requestBody","description":"Payout request resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payout-requests","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}},"responseCodes":["201","401","403","422","429"],"pointer":"/payout-requests","href":"transactions/postpayoutrequest","openApiOperationId":"PostPayoutRequest","summary":"Create a payout request","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/PayoutRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Payout request created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}},"schemaId":"components/schemas/PayoutRequest","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-requests/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PayoutRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/postpayoutrequest"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests"},{"label":"Retrieve a payout request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/getpayoutrequest","routeSlug":"/docs/dev-docs/api/transactions/getpayoutrequest","metadata":{"seo":{"title":"Retrieve a payout request","description":"Retrieves a payout request with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPayoutRequest","name":"Retrieve a payout request","isWebhook":false,"pointer":"/paths/~1payout-requests~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payout request","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a payout request with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-requests~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payout-requests/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/payout-requests/{id}","href":"transactions/getpayoutrequest","openApiOperationId":"GetPayoutRequest","summary":"Retrieve a payout request","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout request retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}},"schemaId":"components/schemas/PayoutRequest"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1payout-requests~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/getpayoutrequest"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}"},{"label":"Upsert a payout request","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/putpayoutrequest","routeSlug":"/docs/dev-docs/api/transactions/putpayoutrequest","metadata":{"seo":{"title":"Upsert a payout request","description":"Creates or updates (upserts) a payout request with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutPayoutRequest","name":"Upsert a payout request","isWebhook":false,"pointer":"/paths/~1payout-requests~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a payout request","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates (upserts) a payout request with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-requests~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}},"schemaId":"components/schemas/PayoutRequest","pointer":"/paths/~1payout-requests~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/payout-requests/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}},"responseCodes":["200","201","401","403","404","422","429"],"pointer":"/payout-requests/{id}","href":"transactions/putpayoutrequest","openApiOperationId":"PutPayoutRequest","summary":"Upsert a payout request","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/PayoutRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout request updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}},"schemaId":"components/schemas/PayoutRequest","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Payout request created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}},"schemaId":"components/schemas/PayoutRequest","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-requests~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}}},{"code":"201","schemaId":"components/schemas/PayoutRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/putpayoutrequest"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}"},{"label":"Update a payout request","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/patchpayoutrequest","routeSlug":"/docs/dev-docs/api/transactions/patchpayoutrequest","metadata":{"seo":{"title":"Update a payout request","description":"Updates a payout request with a specified ID. Use this operation to update the status, description, and blocked state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PatchPayoutRequest","name":"Update a payout request","isWebhook":false,"pointer":"/paths/~1payout-requests~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a payout request","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a payout request with a specified ID. \nUse this operation to update the status, description, and blocked state."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-requests~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_821"}},"schemaId":"schema_821","pointer":"/paths/~1payout-requests~1{id}/patch/requestBody","description":"Fields for updating the payout request status, description, and blocked state."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/payout-requests/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_821"}},"responseCodes":["200","401","403","404","409","422","429"],"pointer":"/payout-requests/{id}","href":"transactions/patchpayoutrequest","openApiOperationId":"PatchPayoutRequest","summary":"Update a payout request","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_821","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_821"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout request updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}},"schemaId":"components/schemas/PayoutRequest","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-requests~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/patchpayoutrequest"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}"},{"label":"Cancel a payout request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestcancellation","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestcancellation","metadata":{"seo":{"title":"Cancel a payout request","description":"Cancels a payout request with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPayoutRequestCancellation","name":"Cancel a payout request","isWebhook":false,"pointer":"/paths/~1payout-requests~1{id}~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a payout request","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels a payout request with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-requests~1{id}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayoutRequestCancellation"}},"schemaId":"components/schemas/PayoutRequestCancellation","pointer":"/paths/~1payout-requests~1{id}~1cancel/post/requestBody","description":"Payout request resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payout-requests/{id}/cancel","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PayoutRequestCancellation"}},"responseCodes":["200","401","403","404","409","422","429"],"pointer":"/payout-requests/{id}/cancel","href":"transactions/postpayoutrequestcancellation","openApiOperationId":"PostPayoutRequestCancellation","summary":"Cancel a payout request","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/PayoutRequestCancellation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayoutRequestCancellation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout request canceled.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}},"schemaId":"components/schemas/PayoutRequest","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-requests~1{id}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequest"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/postpayoutrequestcancellation"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}/cancel"},{"label":"Request a payout request split","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestsplit","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestsplit","metadata":{"seo":{"title":"Request a payout request split","description":"Splits a payout request that is in pending, ready, or approved status into two or more separate requests."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPayoutRequestSplit","name":"Request a payout request split","isWebhook":false,"pointer":"/paths/~1payout-requests~1{id}~1split/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request a payout request split","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Splits a payout request that is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status into two or more separate requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this operation when the full amount cannot be processed due to amount restrictions, but a smaller amount can be processed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if a payout request for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$4,000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be processed, but "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$3,000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be processed, split the request into two. This allows you to approve and process "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$3,000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead of blocking the entire request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide an array of at least two amounts; one new payout request is created per amount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sum of the amounts must equal the original payout request amount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each new payout request is created in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The original request transitions to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"split"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation returns the newly created payout requests."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-requests~1{id}~1split/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayoutRequestSplit"}},"schemaId":"components/schemas/PayoutRequestSplit","pointer":"/paths/~1payout-requests~1{id}~1split/post/requestBody","description":"Payout request split parameters."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payout-requests/{id}/split","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PayoutRequestSplit"}},"responseCodes":["201","401","403","404","409","422","429"],"pointer":"/payout-requests/{id}/split","href":"transactions/postpayoutrequestsplit","openApiOperationId":"PostPayoutRequestSplit","summary":"Request a payout request split","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/PayoutRequestSplit","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayoutRequestSplit"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Payout requests created by the split operation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_820"}},"schemaId":"schema_820","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-requests~1{id}~1split/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_820","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_820"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/postpayoutrequestsplit"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}/split"},{"label":"Retrieve associated payment instruments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/getpayoutrequestpaymentinstruments","routeSlug":"/docs/dev-docs/api/transactions/getpayoutrequestpaymentinstruments","metadata":{"seo":{"title":"Retrieve associated payment instruments","description":"Retrieves the payment gateway and a list of payment instruments that are associated with a payout request with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPayoutRequestPaymentInstruments","name":"Retrieve associated payment instruments","isWebhook":false,"pointer":"/paths/~1payout-requests~1{id}~1payment-instruments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve associated payment instruments","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the payment gateway and a list of payment instruments that are associated with a payout request with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-requests~1{id}~1payment-instruments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payout-requests/{id}/payment-instruments","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/payout-requests/{id}/payment-instruments","href":"transactions/getpayoutrequestpaymentinstruments","openApiOperationId":"GetPayoutRequestPaymentInstruments","summary":"Retrieve associated payment instruments","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout request associated payment instruments retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_822"}},"schemaId":"schema_822"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1payout-requests~1{id}~1payment-instruments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_822","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_822"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/getpayoutrequestpaymentinstruments"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}/payment-instruments"},{"label":"Retrieve payout request allocations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/getpayoutrequestallocationcollection","routeSlug":"/docs/dev-docs/api/transactions/getpayoutrequestallocationcollection","metadata":{"seo":{"title":"Retrieve payout request allocations","description":"Retrieves a list of payout request allocations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPayoutRequestAllocationCollection","name":"Retrieve payout request allocations","isWebhook":false,"pointer":"/paths/~1payout-request-allocations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve payout request allocations","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of payout request allocations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1payout-request-allocations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payout-request-allocations","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/payout-request-allocations","href":"transactions/getpayoutrequestallocationcollection","openApiOperationId":"GetPayoutRequestAllocationCollection","summary":"Retrieve payout request allocations","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of payout request allocations retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_823"}},"schemaId":"schema_823","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1payout-request-allocations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_823","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_823"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/getpayoutrequestallocationcollection"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-allocations"},{"label":"Create a payout request allocation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestallocation","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestallocation","metadata":{"seo":{"title":"Create a payout request allocation","description":"Creates an allocation for a payout request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPayoutRequestAllocation","name":"Create a payout request allocation","isWebhook":false,"pointer":"/paths/~1payout-request-allocations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a payout request allocation","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an allocation for a payout request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an allocation is created, the payout request transitions to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in-progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the allocation starts in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The allocation transitions to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status when payment processing begins."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_824"}},"schemaId":"schema_824","pointer":"/paths/~1payout-request-allocations/post/requestBody","description":"Payout request allocation resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payout-request-allocations","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_824"}},"responseCodes":["201","401","403","404","409","422","429"],"pointer":"/payout-request-allocations","href":"transactions/postpayoutrequestallocation","openApiOperationId":"PostPayoutRequestAllocation","summary":"Create a payout request allocation","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_824","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_824"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Payout request allocation created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestAllocation"}},"schemaId":"components/schemas/PayoutRequestAllocation","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-request-allocations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PayoutRequestAllocation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestAllocation"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/postpayoutrequestallocation"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-allocations"},{"label":"Create an automatic payout request allocation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestautoallocation","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestautoallocation","metadata":{"seo":{"title":"Create an automatic payout request allocation","description":"Creates an automatic payout request allocation using system-selected parameters.Only the payout request ID is required; all allocation details are determined automatically."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPayoutRequestAutoAllocation","name":"Create an automatic payout request allocation","isWebhook":false,"pointer":"/paths/~1payout-request-allocations~1auto/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an automatic payout request allocation","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an automatic payout request allocation using system-selected parameters."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the payout request ID is required; all allocation details are determined automatically."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an allocation is created, the payout request transitions to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in-progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the allocation starts in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The allocation transitions to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status when payment processing begins."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_825"}},"schemaId":"schema_825","pointer":"/paths/~1payout-request-allocations~1auto/post/requestBody","description":"Payout request allocation resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payout-request-allocations/auto","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_825"}},"responseCodes":["204","401","403","404","409","422","429"],"pointer":"/payout-request-allocations/auto","href":"transactions/postpayoutrequestautoallocation","openApiOperationId":"PostPayoutRequestAutoAllocation","summary":"Create an automatic payout request allocation","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_825","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_825"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Payout request auto-allocation completed."},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-request-allocations~1auto/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/postpayoutrequestautoallocation"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-allocations/auto"},{"label":"Retrieve a payout request allocation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/getpayoutrequestallocation","routeSlug":"/docs/dev-docs/api/transactions/getpayoutrequestallocation","metadata":{"seo":{"title":"Retrieve a payout request allocation","description":"Retrieves a payout request allocation with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPayoutRequestAllocation","name":"Retrieve a payout request allocation","isWebhook":false,"pointer":"/paths/~1payout-request-allocations~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payout request allocation","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a payout request allocation with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-request-allocations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payout-request-allocations/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/payout-request-allocations/{id}","href":"transactions/getpayoutrequestallocation","openApiOperationId":"GetPayoutRequestAllocation","summary":"Retrieve a payout request allocation","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout request allocation retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestAllocation"}},"schemaId":"components/schemas/PayoutRequestAllocation"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1payout-request-allocations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutRequestAllocation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestAllocation"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/getpayoutrequestallocation"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-allocations/{id}"},{"label":"Update allocation status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/patchpayoutrequestallocation","routeSlug":"/docs/dev-docs/api/transactions/patchpayoutrequestallocation","metadata":{"seo":{"title":"Update allocation status","description":"Updates the status of a payout request allocation with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PatchPayoutRequestAllocation","name":"Update allocation status","isWebhook":false,"pointer":"/paths/~1payout-request-allocations~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update allocation status","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the status of a payout request allocation with a specified ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" statuses can be set with this operation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status transitions an allocation from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when payment processing begins."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status stops the allocation before it is processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waiting-completion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" statuses are set automatically during transaction processing."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allocations are always created in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-request-allocations~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_826"}},"schemaId":"schema_826","pointer":"/paths/~1payout-request-allocations~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/payout-request-allocations/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_826"}},"responseCodes":["200","401","403","404","409","422","429"],"pointer":"/payout-request-allocations/{id}","href":"transactions/patchpayoutrequestallocation","openApiOperationId":"PatchPayoutRequestAllocation","summary":"Update allocation status","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_826","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_826"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout request allocation updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestAllocation"}},"schemaId":"components/schemas/PayoutRequestAllocation","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-request-allocations~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutRequestAllocation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestAllocation"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/patchpayoutrequestallocation"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-allocations/{id}"},{"label":"Initiate processing of allocations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestallocationsprocess","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestallocationsprocess","metadata":{"seo":{"title":"Initiate processing of allocations","description":"Initiates the processing of one or more payout request allocations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPayoutRequestAllocationsProcess","name":"Initiate processing of allocations","isWebhook":false,"pointer":"/paths/~1payout-request-allocations~1process/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiate processing of allocations","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates the processing of one or more payout request allocations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only allocations with status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are processed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each allocation is processed by creating a transaction."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_827"}},"schemaId":"schema_827","pointer":"/paths/~1payout-request-allocations~1process/post/requestBody","description":"Allocation processing options."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payout-request-allocations/process","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_827"}},"responseCodes":["204","401","403","422","429"],"pointer":"/payout-request-allocations/process","href":"transactions/postpayoutrequestallocationsprocess","openApiOperationId":"PostPayoutRequestAllocationsProcess","summary":"Initiate processing of allocations","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_827","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_827"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Allocation processing has been initiated.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-request-allocations~1process/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/postpayoutrequestallocationsprocess"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-allocations/process"},{"label":"Retrieve payout request batches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/getpayoutrequestbatchcollection","routeSlug":"/docs/dev-docs/api/transactions/getpayoutrequestbatchcollection","metadata":{"seo":{"title":"Retrieve payout request batches","description":"Retrieves a list of payout request batches."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPayoutRequestBatchCollection","name":"Retrieve payout request batches","isWebhook":false,"pointer":"/paths/~1payout-request-batches/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve payout request batches","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of payout request batches."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1payout-request-batches/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payout-request-batches","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"q","in":"query","schemaId":"schema_782"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","429"],"pointer":"/payout-request-batches","href":"transactions/getpayoutrequestbatchcollection","openApiOperationId":"GetPayoutRequestBatchCollection","summary":"Retrieve payout request batches","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of payout request batches retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_828"}},"schemaId":"schema_828","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-request-batches/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_828","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_828"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/getpayoutrequestbatchcollection"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches"},{"label":"Create a payout request batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestbatch","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestbatch","metadata":{"seo":{"title":"Create a payout request batch","description":"Creates a batch of payout requests for batch processing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPayoutRequestBatch","name":"Create a payout request batch","isWebhook":false,"pointer":"/paths/~1payout-request-batches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a payout request batch","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a batch of payout requests for batch processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch links multiple payout requests together so they can be auto-allocated and processed together."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each payout request can be assigned to only one batch."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If any of the specified payout requests are already included in another batch, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both approaches are limited to a maximum of 1000 payout requests per batch."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two mutually exclusive approaches are supported:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explicit IDs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Provide an array of payout request IDs in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payoutRequestIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter-based"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Provide a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" string to select payout requests that match the specified criteria at execution time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout requests that are already included in a batch are automatically excluded from the filter results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If more than 1000 payout requests match the filter, only the oldest 1000 are included in the batch, sorted by creation time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view the number of matching items before creating the batch, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../GetPayoutRequestBatchPreview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview payout request batch filter results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_829"}},"schemaId":"schema_829","pointer":"/paths/~1payout-request-batches/post/requestBody","description":"Resource for the payout request batch."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payout-request-batches","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_829"}},"responseCodes":["201","400","401","403","409","422","429"],"pointer":"/payout-request-batches","href":"transactions/postpayoutrequestbatch","openApiOperationId":"PostPayoutRequestBatch","summary":"Create a payout request batch","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_829","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_829"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Payout request batch created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}},"schemaId":"components/schemas/PayoutRequestBatch","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"400","description":"Invalid filter provided or no payout requests match the filter.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-request-batches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PayoutRequestBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/postpayoutrequestbatch"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches"},{"label":"Retrieve a payout request batch","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/getpayoutrequestbatch","routeSlug":"/docs/dev-docs/api/transactions/getpayoutrequestbatch","metadata":{"seo":{"title":"Retrieve a payout request batch","description":"Retrieves a payout request batch with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPayoutRequestBatch","name":"Retrieve a payout request batch","isWebhook":false,"pointer":"/paths/~1payout-request-batches~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payout request batch","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a payout request batch with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-request-batches~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payout-request-batches/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","429"],"pointer":"/payout-request-batches/{id}","href":"transactions/getpayoutrequestbatch","openApiOperationId":"GetPayoutRequestBatch","summary":"Retrieve a payout request batch","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout request batch retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}},"schemaId":"components/schemas/PayoutRequestBatch","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-request-batches~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutRequestBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/getpayoutrequestbatch"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}"},{"label":"Update a payout request batch","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/patchpayoutrequestbatch","routeSlug":"/docs/dev-docs/api/transactions/patchpayoutrequestbatch","metadata":{"seo":{"title":"Update a payout request batch","description":"Partially updates a payout request batch with a specified ID. Use this operation to update the description and allocation order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PatchPayoutRequestBatch","name":"Update a payout request batch","isWebhook":false,"pointer":"/paths/~1payout-request-batches~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a payout request batch","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially updates a payout request batch with a specified ID.\nUse this operation to update the description and allocation order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-request-batches~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_830"}},"schemaId":"schema_830","pointer":"/paths/~1payout-request-batches~1{id}/patch/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields for updating the payout request batch."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one property must be present."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allocationOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/payout-request-batches/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_830"}},"responseCodes":["200","401","403","404","422","429"],"pointer":"/payout-request-batches/{id}","href":"transactions/patchpayoutrequestbatch","openApiOperationId":"PatchPayoutRequestBatch","summary":"Update a payout request batch","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_830","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_830"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout request batch updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}},"schemaId":"components/schemas/PayoutRequestBatch","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-request-batches~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutRequestBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/patchpayoutrequestbatch"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}"},{"label":"Delete a payout request batch","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/deletepayoutrequestbatch","routeSlug":"/docs/dev-docs/api/transactions/deletepayoutrequestbatch","metadata":{"seo":{"title":"Delete a payout request batch","description":"Deletes a payout request batch with a specified ID and clears the batchId field from every payout request in the batch.This operation preserves every payout request, status, and blocked state.This operation is atomic. It clears all batchId fields or leaves them all unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePayoutRequestBatch","name":"Delete a payout request batch","isWebhook":false,"pointer":"/paths/~1payout-request-batches~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a payout request batch","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a payout request batch with a specified ID and clears the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field from every payout request in the batch."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation preserves every payout request, status, and blocked state."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is atomic. It clears all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields or leaves them all unchanged."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-request-batches~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/payout-request-batches/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","429"],"pointer":"/payout-request-batches/{id}","href":"transactions/deletepayoutrequestbatch","openApiOperationId":"DeletePayoutRequestBatch","summary":"Delete a payout request batch","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Payout request batch deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-request-batches~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/deletepayoutrequestbatch"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}"},{"label":"Allocate batch payout requests automatically","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestbatchautoallocate","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestbatchautoallocate","metadata":{"seo":{"title":"Allocate batch payout requests automatically","description":"Creates allocations automatically for all payout requests in the batch using the auto-allocation algorithm."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPayoutRequestBatchAutoAllocate","name":"Allocate batch payout requests automatically","isWebhook":false,"pointer":"/paths/~1payout-request-batches~1{id}~1auto-allocate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Allocate batch payout requests automatically","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates allocations automatically for all payout requests in the batch using the auto-allocation algorithm.\n\nEach payout request is processed independently."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-request-batches~1{id}~1auto-allocate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payout-request-batches/{id}/auto-allocate","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","409","422","429"],"pointer":"/payout-request-batches/{id}/auto-allocate","href":"transactions/postpayoutrequestbatchautoallocate","openApiOperationId":"PostPayoutRequestBatchAutoAllocate","summary":"Allocate batch payout requests automatically","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch auto-allocation completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}},"schemaId":"components/schemas/PayoutRequestBatch","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-request-batches~1{id}~1auto-allocate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutRequestBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/postpayoutrequestbatchautoallocate"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}/auto-allocate"},{"label":"Approve payout requests in a batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestbatchapprove","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestbatchapprove","metadata":{"seo":{"title":"Approve payout requests in a batch","description":"Approves all payout requests in a specified batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPayoutRequestBatchApprove","name":"Approve payout requests in a batch","isWebhook":false,"pointer":"/paths/~1payout-request-batches~1{id}~1approve/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Approve payout requests in a batch","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approves all payout requests in a specified batch."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each payout request is processed independently."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only payout requests with a status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be approved."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-request-batches~1{id}~1approve/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payout-request-batches/{id}/approve","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","409","422","429"],"pointer":"/payout-request-batches/{id}/approve","href":"transactions/postpayoutrequestbatchapprove","openApiOperationId":"PostPayoutRequestBatchApprove","summary":"Approve payout requests in a batch","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch approval completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}},"schemaId":"components/schemas/PayoutRequestBatch","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-request-batches~1{id}~1approve/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutRequestBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/postpayoutrequestbatchapprove"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}/approve"},{"label":"Block batch payout requests","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestbatchblock","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestbatchblock","metadata":{"seo":{"title":"Block batch payout requests","description":"Blocks all payout requests in a specified batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPayoutRequestBatchBlock","name":"Block batch payout requests","isWebhook":false,"pointer":"/paths/~1payout-request-batches~1{id}~1block/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Block batch payout requests","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Blocks all payout requests in a specified batch.\n\nEach payout request is processed independently."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-request-batches~1{id}~1block/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_831"}},"schemaId":"schema_831","pointer":"/paths/~1payout-request-batches~1{id}~1block/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payout-request-batches/{id}/block","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_831"}},"responseCodes":["200","401","403","404","409","422","429"],"pointer":"/payout-request-batches/{id}/block","href":"transactions/postpayoutrequestbatchblock","openApiOperationId":"PostPayoutRequestBatchBlock","summary":"Block batch payout requests","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_831","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_831"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch blocking completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}},"schemaId":"components/schemas/PayoutRequestBatch","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-request-batches~1{id}~1block/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutRequestBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/postpayoutrequestbatchblock"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}/block"},{"label":"Add requests to a payout request batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequeststobatch","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequeststobatch","metadata":{"seo":{"title":"Add requests to a payout request batch","description":"Adds payout requests to a batch with a specified ID.Accepts payout requests in any status, with or without allocations.A batch contains a maximum of 1000 payout requests."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPayoutRequestsToBatch","name":"Add requests to a payout request batch","isWebhook":false,"pointer":"/paths/~1payout-request-batches~1{id}~1payout-requests/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add requests to a payout request batch","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds payout requests to a batch with a specified ID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepts payout requests in any status, with or without allocations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A batch contains a maximum of 1000 payout requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide exactly one of the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payoutRequestIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to add specific payout requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to add payout requests that match the filter when the operation runs."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If any explicitly specified payout request is already associated with a batch,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the operation returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter results exclude payout requests that are already associated with a batch."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If more payout requests match the filter than the batch can contain,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the operation adds only the oldest matching requests up to the batch limit,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sorted by creation time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If adding explicitly specified payout requests would increase the batch to more than 1000 requests,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the operation returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the batch has reached its payout request limit,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the operation returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response for either selection method."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is atomic. If a conflict occurs, the operation adds no payout requests to the batch."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-request-batches~1{id}~1payout-requests/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_832"}},"schemaId":"schema_832","pointer":"/paths/~1payout-request-batches~1{id}~1payout-requests/post/requestBody","description":"Selection of payout requests to add to the batch."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payout-request-batches/{id}/payout-requests","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_832"}},"responseCodes":["200","400","401","403","404","409","422","429"],"pointer":"/payout-request-batches/{id}/payout-requests","href":"transactions/postpayoutrequeststobatch","openApiOperationId":"PostPayoutRequestsToBatch","summary":"Add requests to a payout request batch","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_832","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_832"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout requests added to the batch.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}},"schemaId":"components/schemas/PayoutRequestBatch","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"400","description":"Invalid filter provided or no payout requests match the filter.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Batch limit reached or would be exceeded, or one or more explicitly specified payout requests are already associated with a batch.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-request-batches~1{id}~1payout-requests/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutRequestBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/postpayoutrequeststobatch"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}/payout-requests"},{"label":"Remove requests from a payout request batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postremovepayoutrequestsfrombatch","routeSlug":"/docs/dev-docs/api/transactions/postremovepayoutrequestsfrombatch","metadata":{"seo":{"title":"Remove requests from a payout request batch","description":"Removes specified payout requests from a batch with a specified ID by clearing batchId on each request.This operation preserves each payout request, status, and blocked state.Removes requests regardless of status or allocations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostRemovePayoutRequestsFromBatch","name":"Remove requests from a payout request batch","isWebhook":false,"pointer":"/paths/~1payout-request-batches~1{id}~1payout-requests~1remove/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove requests from a payout request batch","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes specified payout requests from a batch with a specified ID by clearing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on each request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation preserves each payout request, status, and blocked state."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes requests regardless of status or allocations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is atomic."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If any payout request is not associated with the specified batch,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the operation clears no associations with the batch."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-request-batches~1{id}~1payout-requests~1remove/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_833"}},"schemaId":"schema_833","pointer":"/paths/~1payout-request-batches~1{id}~1payout-requests~1remove/post/requestBody","description":"Payout requests to remove from the batch."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payout-request-batches/{id}/payout-requests/remove","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_833"}},"responseCodes":["200","401","403","404","409","422","429"],"pointer":"/payout-request-batches/{id}/payout-requests/remove","href":"transactions/postremovepayoutrequestsfrombatch","openApiOperationId":"PostRemovePayoutRequestsFromBatch","summary":"Remove requests from a payout request batch","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_833","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_833"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout requests removed from the batch.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}},"schemaId":"components/schemas/PayoutRequestBatch","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"One or more payout requests are not associated with the specified batch.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-request-batches~1{id}~1payout-requests~1remove/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutRequestBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/postremovepayoutrequestsfrombatch"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}/payout-requests/remove"},{"label":"Unblock payout requests in a batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/postpayoutrequestbatchunblock","routeSlug":"/docs/dev-docs/api/transactions/postpayoutrequestbatchunblock","metadata":{"seo":{"title":"Unblock payout requests in a batch","description":"Unblocks every blocked payout request in a batch with a specified ID. Leaves payout requests without a block unchanged. Processes all requests in the batch, up to the 1000-request batch limit, without changing batch membership. This operation is atomic."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPayoutRequestBatchUnblock","name":"Unblock payout requests in a batch","isWebhook":false,"pointer":"/paths/~1payout-request-batches~1{id}~1unblock/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unblock payout requests in a batch","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Unblocks every blocked payout request in a batch with a specified ID.\nLeaves payout requests without a block unchanged.\nProcesses all requests in the batch, up to the 1000-request batch limit, without changing batch membership.\nThis operation is atomic."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-request-batches~1{id}~1unblock/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payout-request-batches/{id}/unblock","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","429"],"pointer":"/payout-request-batches/{id}/unblock","href":"transactions/postpayoutrequestbatchunblock","openApiOperationId":"PostPayoutRequestBatchUnblock","summary":"Unblock payout requests in a batch","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout requests in the batch unblocked.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}},"schemaId":"components/schemas/PayoutRequestBatch","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-request-batches~1{id}~1unblock/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutRequestBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestBatch"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/postpayoutrequestbatchunblock"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/{id}/unblock"},{"label":"Preview payout request batch results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions/getpayoutrequestbatchpreview","routeSlug":"/docs/dev-docs/api/transactions/getpayoutrequestbatchpreview","metadata":{"seo":{"title":"Preview payout request batch results","description":"Retrieves aggregate information for the payout requests that match a specified filter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPayoutRequestBatchPreview","name":"Preview payout request batch results","isWebhook":false,"pointer":"/paths/~1payout-request-batches~1preview/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview payout request batch results","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves aggregate information for the payout requests that match a specified filter.\n\nIf more than 1000 payout requests match the filter, only the oldest 1000 are included in the preview."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_834","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter string that is used to select payout requests."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field uses the same format as collection filter parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use semicolons to separate multiple filter conditions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available filter fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"websiteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter is provided, it is ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout requests that are already included in a batch are always excluded from the results."},"children":[]}]}]}]}],"pointer":"/paths/~1payout-request-batches~1preview/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payout-request-batches/preview","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","example":"status:pending;websiteId:ws_0YVDMDE2BMC6KBB5MX76RF6T80","schemaId":"schema_834"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/payout-request-batches/preview","href":"transactions/getpayoutrequestbatchpreview","openApiOperationId":"GetPayoutRequestBatchPreview","summary":"Preview payout request batch results","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Preview retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_835"}},"schemaId":"schema_835"},{"code":"400","description":"Empty or invalid filter provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-request-batches~1preview/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_835","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_835"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/getpayoutrequestbatchpreview"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-request-batches/preview"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Customer redirected offsite","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/customer-redirected-offsite","routeSlug":"/docs/dev-docs/api/transactions/customer-redirected-offsite","metadata":{"seo":{"title":"Customer redirected offsite","description":"Customer redirected offsite"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customer-redirected-offsite","name":"Customer redirected offsite","isWebhook":true,"pointer":"/paths/customer-redirected-offsite/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer redirected offsite","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_836"}},"schemaId":"schema_836","pointer":"/paths/customer-redirected-offsite/post/requestBody","description":"Payload of customer redirect-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"customer-redirected-offsite","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_836"}},"responseCodes":["2xx"],"pointer":"customer-redirected-offsite","href":"transactions/customer-redirected-offsite","openApiOperationId":"customer-redirected-offsite","summary":"Customer redirected offsite","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_836","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_836"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/customer-redirected-offsite/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/customer-redirected-offsite"}],"panels":[]}]},"httpPath":"customer-redirected-offsite"},{"label":"Customer returned","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/customer-returned","routeSlug":"/docs/dev-docs/api/transactions/customer-returned","metadata":{"seo":{"title":"Customer returned","description":"Customer returned"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customer-returned","name":"Customer returned","isWebhook":true,"pointer":"/paths/customer-returned/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer returned","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_836"}},"schemaId":"schema_836","pointer":"/paths/customer-returned/post/requestBody","description":"Payload of customer redirect-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"customer-returned","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_836"}},"responseCodes":["2xx"],"pointer":"customer-returned","href":"transactions/customer-returned","openApiOperationId":"customer-returned","summary":"Customer returned","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_836","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_836"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/customer-returned/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/customer-returned"}],"panels":[]}]},"httpPath":"customer-returned"},{"label":"Gateway account requested","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/gateway-account-requested","routeSlug":"/docs/dev-docs/api/transactions/gateway-account-requested","metadata":{"seo":{"title":"Gateway account requested","description":"Gateway account requested"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"gateway-account-requested","name":"Gateway account requested","isWebhook":true,"pointer":"/paths/gateway-account-requested/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gateway account requested","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"schemaId":"schema_837","pointer":"/paths/gateway-account-requested/post/requestBody","description":"Payload of transaction-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"gateway-account-requested","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_837"}},"responseCodes":["2xx"],"pointer":"gateway-account-requested","href":"transactions/gateway-account-requested","openApiOperationId":"gateway-account-requested","summary":"Gateway account requested","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_837","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/gateway-account-requested/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/gateway-account-requested"}],"panels":[]}]},"httpPath":"gateway-account-requested"},{"label":"Offsite payment completed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/offsite-payment-completed","routeSlug":"/docs/dev-docs/api/transactions/offsite-payment-completed","metadata":{"seo":{"title":"Offsite payment completed","description":"Offsite payment completed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"offsite-payment-completed","name":"Offsite payment completed","isWebhook":true,"pointer":"/paths/offsite-payment-completed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Offsite payment completed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"schemaId":"schema_837","pointer":"/paths/offsite-payment-completed/post/requestBody","description":"Payload of transaction-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"offsite-payment-completed","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_837"}},"responseCodes":["2xx"],"pointer":"offsite-payment-completed","href":"transactions/offsite-payment-completed","openApiOperationId":"offsite-payment-completed","summary":"Offsite payment completed","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_837","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/offsite-payment-completed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/offsite-payment-completed"}],"panels":[]}]},"httpPath":"offsite-payment-completed"},{"label":"Payout request canceled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/payout-request-canceled","routeSlug":"/docs/dev-docs/api/transactions/payout-request-canceled","metadata":{"seo":{"title":"Payout request canceled","description":"Payout request canceled"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"payout-request-canceled","name":"Payout request canceled","isWebhook":true,"pointer":"/paths/payout-request-canceled/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payout request canceled","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_838"}},"schemaId":"schema_838","pointer":"/paths/payout-request-canceled/post/requestBody","description":"Payload of payout request-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"payout-request-canceled","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_838"}},"responseCodes":["2xx"],"pointer":"payout-request-canceled","href":"transactions/payout-request-canceled","openApiOperationId":"payout-request-canceled","summary":"Payout request canceled","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_838","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_838"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/payout-request-canceled/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/payout-request-canceled"}],"panels":[]}]},"httpPath":"payout-request-canceled"},{"label":"Payout request created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/payout-request-created","routeSlug":"/docs/dev-docs/api/transactions/payout-request-created","metadata":{"seo":{"title":"Payout request created","description":"Payout request created"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"payout-request-created","name":"Payout request created","isWebhook":true,"pointer":"/paths/payout-request-created/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payout request created","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_838"}},"schemaId":"schema_838","pointer":"/paths/payout-request-created/post/requestBody","description":"Payload of payout request-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"payout-request-created","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_838"}},"responseCodes":["2xx"],"pointer":"payout-request-created","href":"transactions/payout-request-created","openApiOperationId":"payout-request-created","summary":"Payout request created","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_838","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_838"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/payout-request-created/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/payout-request-created"}],"panels":[]}]},"httpPath":"payout-request-created"},{"label":"Payout request fulfilled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/payout-request-fulfilled","routeSlug":"/docs/dev-docs/api/transactions/payout-request-fulfilled","metadata":{"seo":{"title":"Payout request fulfilled","description":"Payout request fulfilled"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"payout-request-fulfilled","name":"Payout request fulfilled","isWebhook":true,"pointer":"/paths/payout-request-fulfilled/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payout request fulfilled","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_838"}},"schemaId":"schema_838","pointer":"/paths/payout-request-fulfilled/post/requestBody","description":"Payload of payout request-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"payout-request-fulfilled","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_838"}},"responseCodes":["2xx"],"pointer":"payout-request-fulfilled","href":"transactions/payout-request-fulfilled","openApiOperationId":"payout-request-fulfilled","summary":"Payout request fulfilled","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_838","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_838"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/payout-request-fulfilled/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/payout-request-fulfilled"}],"panels":[]}]},"httpPath":"payout-request-fulfilled"},{"label":"Payout request modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/payout-request-modified","routeSlug":"/docs/dev-docs/api/transactions/payout-request-modified","metadata":{"seo":{"title":"Payout request modified","description":"Payout request modified"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"payout-request-modified","name":"Payout request modified","isWebhook":true,"pointer":"/paths/payout-request-modified/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payout request modified","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_838"}},"schemaId":"schema_838","pointer":"/paths/payout-request-modified/post/requestBody","description":"Payload of payout request-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"payout-request-modified","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_838"}},"responseCodes":["2xx"],"pointer":"payout-request-modified","href":"transactions/payout-request-modified","openApiOperationId":"payout-request-modified","summary":"Payout request modified","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_838","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_838"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/payout-request-modified/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/payout-request-modified"}],"panels":[]}]},"httpPath":"payout-request-modified"},{"label":"Ready to pay requested","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/ready-to-pay-requested","routeSlug":"/docs/dev-docs/api/transactions/ready-to-pay-requested","metadata":{"seo":{"title":"Ready to pay requested","description":"Ready to pay requested"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ready-to-pay-requested","name":"Ready to pay requested","isWebhook":true,"pointer":"/paths/ready-to-pay-requested/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ready to pay requested","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_839"}},"schemaId":"schema_839","pointer":"/paths/ready-to-pay-requested/post/requestBody","description":"Payload of ready to pay-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"ready-to-pay-requested","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_839"}},"responseCodes":["2xx"],"pointer":"ready-to-pay-requested","href":"transactions/ready-to-pay-requested","openApiOperationId":"ready-to-pay-requested","summary":"Ready to pay requested","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_839","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_839"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/ready-to-pay-requested/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/ready-to-pay-requested"}],"panels":[]}]},"httpPath":"ready-to-pay-requested"},{"label":"Risk score changed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/risk-score-changed","routeSlug":"/docs/dev-docs/api/transactions/risk-score-changed","metadata":{"seo":{"title":"Risk score changed","description":"Risk score changed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"risk-score-changed","name":"Risk score changed","isWebhook":true,"pointer":"/paths/risk-score-changed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Risk score changed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"schemaId":"schema_837","pointer":"/paths/risk-score-changed/post/requestBody","description":"Payload of transaction-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"risk-score-changed","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_837"}},"responseCodes":["2xx"],"pointer":"risk-score-changed","href":"transactions/risk-score-changed","openApiOperationId":"risk-score-changed","summary":"Risk score changed","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_837","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/risk-score-changed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/risk-score-changed"}],"panels":[]}]},"httpPath":"risk-score-changed"},{"label":"Transaction amount discrepancy found","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-amount-discrepancy-found","routeSlug":"/docs/dev-docs/api/transactions/transaction-amount-discrepancy-found","metadata":{"seo":{"title":"Transaction amount discrepancy found","description":"Transaction amount discrepancy found"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transaction-amount-discrepancy-found","name":"Transaction amount discrepancy found","isWebhook":true,"pointer":"/paths/transaction-amount-discrepancy-found/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction amount discrepancy found","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"schemaId":"schema_837","pointer":"/paths/transaction-amount-discrepancy-found/post/requestBody","description":"Payload of transaction-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transaction-amount-discrepancy-found","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_837"}},"responseCodes":["2xx"],"pointer":"transaction-amount-discrepancy-found","href":"transactions/transaction-amount-discrepancy-found","openApiOperationId":"transaction-amount-discrepancy-found","summary":"Transaction amount discrepancy found","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_837","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/transaction-amount-discrepancy-found/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/transaction-amount-discrepancy-found"}],"panels":[]}]},"httpPath":"transaction-amount-discrepancy-found"},{"label":"Transaction declined","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-declined","routeSlug":"/docs/dev-docs/api/transactions/transaction-declined","metadata":{"seo":{"title":"Transaction declined","description":"Transaction declined"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transaction-declined","name":"Transaction declined","isWebhook":true,"pointer":"/paths/transaction-declined/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction declined","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"schemaId":"schema_837","pointer":"/paths/transaction-declined/post/requestBody","description":"Payload of transaction-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transaction-declined","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_837"}},"responseCodes":["2xx"],"pointer":"transaction-declined","href":"transactions/transaction-declined","openApiOperationId":"transaction-declined","summary":"Transaction declined","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_837","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/transaction-declined/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/transaction-declined"}],"panels":[]}]},"httpPath":"transaction-declined"},{"label":"Transaction discrepancy found","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-discrepancy-found","routeSlug":"/docs/dev-docs/api/transactions/transaction-discrepancy-found","metadata":{"seo":{"title":"Transaction discrepancy found","description":"Transaction discrepancy found"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transaction-discrepancy-found","name":"Transaction discrepancy found","isWebhook":true,"pointer":"/paths/transaction-discrepancy-found/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction discrepancy found","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"schemaId":"schema_837","pointer":"/paths/transaction-discrepancy-found/post/requestBody","description":"Payload of transaction-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transaction-discrepancy-found","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_837"}},"responseCodes":["2xx"],"pointer":"transaction-discrepancy-found","href":"transactions/transaction-discrepancy-found","openApiOperationId":"transaction-discrepancy-found","summary":"Transaction discrepancy found","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_837","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/transaction-discrepancy-found/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/transaction-discrepancy-found"}],"panels":[]}]},"httpPath":"transaction-discrepancy-found"},{"label":"Transaction process requested","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-process-requested","routeSlug":"/docs/dev-docs/api/transactions/transaction-process-requested","metadata":{"seo":{"title":"Transaction process requested","description":"Transaction process requested"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transaction-process-requested","name":"Transaction process requested","isWebhook":true,"pointer":"/paths/transaction-process-requested/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction process requested","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"schemaId":"schema_837","pointer":"/paths/transaction-process-requested/post/requestBody","description":"Payload of transaction-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transaction-process-requested","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_837"}},"responseCodes":["2xx"],"pointer":"transaction-process-requested","href":"transactions/transaction-process-requested","openApiOperationId":"transaction-process-requested","summary":"Transaction process requested","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_837","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/transaction-process-requested/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/transaction-process-requested"}],"panels":[]}]},"httpPath":"transaction-process-requested"},{"label":"Transaction processed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-processed","routeSlug":"/docs/dev-docs/api/transactions/transaction-processed","metadata":{"seo":{"title":"Transaction processed","description":"Transaction processed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transaction-processed","name":"Transaction processed","isWebhook":true,"pointer":"/paths/transaction-processed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction processed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"schemaId":"schema_837","pointer":"/paths/transaction-processed/post/requestBody","description":"Payload of transaction-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transaction-processed","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_837"}},"responseCodes":["2xx"],"pointer":"transaction-processed","href":"transactions/transaction-processed","openApiOperationId":"transaction-processed","summary":"Transaction processed","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_837","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/transaction-processed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/transaction-processed"}],"panels":[]}]},"httpPath":"transaction-processed"},{"label":"Transaction reconciled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-reconciled","routeSlug":"/docs/dev-docs/api/transactions/transaction-reconciled","metadata":{"seo":{"title":"Transaction reconciled","description":"Transaction reconciled"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transaction-reconciled","name":"Transaction reconciled","isWebhook":true,"pointer":"/paths/transaction-reconciled/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction reconciled","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"schemaId":"schema_837","pointer":"/paths/transaction-reconciled/post/requestBody","description":"Payload of transaction-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transaction-reconciled","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_837"}},"responseCodes":["2xx"],"pointer":"transaction-reconciled","href":"transactions/transaction-reconciled","openApiOperationId":"transaction-reconciled","summary":"Transaction reconciled","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_837","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/transaction-reconciled/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/transaction-reconciled"}],"panels":[]}]},"httpPath":"transaction-reconciled"},{"label":"Transaction partially refunded","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-partially-refunded","routeSlug":"/docs/dev-docs/api/transactions/transaction-partially-refunded","metadata":{"seo":{"title":"Transaction partially refunded","description":"Transaction partially refunded"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transaction-partially-refunded","name":"Transaction partially refunded","isWebhook":true,"pointer":"/paths/transaction-partially-refunded/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction partially refunded","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_840"}},"schemaId":"schema_840","pointer":"/paths/transaction-partially-refunded/post/requestBody","description":"Payload of transaction-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transaction-partially-refunded","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_840"}},"responseCodes":["2xx"],"pointer":"transaction-partially-refunded","href":"transactions/transaction-partially-refunded","openApiOperationId":"transaction-partially-refunded","summary":"Transaction partially refunded","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_840","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_840"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/transaction-partially-refunded/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/transaction-partially-refunded"}],"panels":[]}]},"httpPath":"transaction-partially-refunded"},{"label":"Transaction refunded","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-refunded","routeSlug":"/docs/dev-docs/api/transactions/transaction-refunded","metadata":{"seo":{"title":"Transaction refunded","description":"Transaction refunded"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transaction-refunded","name":"Transaction refunded","isWebhook":true,"pointer":"/paths/transaction-refunded/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction refunded","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_840"}},"schemaId":"schema_840","pointer":"/paths/transaction-refunded/post/requestBody","description":"Payload of transaction-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transaction-refunded","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_840"}},"responseCodes":["2xx"],"pointer":"transaction-refunded","href":"transactions/transaction-refunded","openApiOperationId":"transaction-refunded","summary":"Transaction refunded","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_840","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_840"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/transaction-refunded/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/transaction-refunded"}],"panels":[]}]},"httpPath":"transaction-refunded"},{"label":"Transaction voided","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-voided","routeSlug":"/docs/dev-docs/api/transactions/transaction-voided","metadata":{"seo":{"title":"Transaction voided","description":"Transaction voided"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transaction-voided","name":"Transaction voided","isWebhook":true,"pointer":"/paths/transaction-voided/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction voided","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_840"}},"schemaId":"schema_840","pointer":"/paths/transaction-voided/post/requestBody","description":"Payload of transaction-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transaction-voided","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_840"}},"responseCodes":["2xx"],"pointer":"transaction-voided","href":"transactions/transaction-voided","openApiOperationId":"transaction-voided","summary":"Transaction voided","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_840","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_840"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/transaction-voided/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/transaction-voided"}],"panels":[]}]},"httpPath":"transaction-voided"},{"label":"Transaction timeout resolved","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/transaction-timeout-resolved","routeSlug":"/docs/dev-docs/api/transactions/transaction-timeout-resolved","metadata":{"seo":{"title":"Transaction timeout resolved","description":"Transaction timeout resolved"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transaction-timeout-resolved","name":"Transaction timeout resolved","isWebhook":true,"pointer":"/paths/transaction-timeout-resolved/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction timeout resolved","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"schemaId":"schema_837","pointer":"/paths/transaction-timeout-resolved/post/requestBody","description":"Payload of transaction-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transaction-timeout-resolved","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_837"}},"responseCodes":["2xx"],"pointer":"transaction-timeout-resolved","href":"transactions/transaction-timeout-resolved","openApiOperationId":"transaction-timeout-resolved","summary":"Transaction timeout resolved","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_837","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/transaction-timeout-resolved/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/transaction-timeout-resolved"}],"panels":[]}]},"httpPath":"transaction-timeout-resolved"},{"label":"Waiting gateway transaction completed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/waiting-gateway-transaction-completed","routeSlug":"/docs/dev-docs/api/transactions/waiting-gateway-transaction-completed","metadata":{"seo":{"title":"Waiting gateway transaction completed","description":"Waiting gateway transaction completed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"waiting-gateway-transaction-completed","name":"Waiting gateway transaction completed","isWebhook":true,"pointer":"/paths/waiting-gateway-transaction-completed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Waiting gateway transaction completed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"schemaId":"schema_837","pointer":"/paths/waiting-gateway-transaction-completed/post/requestBody","description":"Payload of transaction-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"waiting-gateway-transaction-completed","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_837"}},"responseCodes":["2xx"],"pointer":"waiting-gateway-transaction-completed","href":"transactions/waiting-gateway-transaction-completed","openApiOperationId":"waiting-gateway-transaction-completed","summary":"Waiting gateway transaction completed","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_837","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_837"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/waiting-gateway-transaction-completed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/waiting-gateway-transaction-completed"}],"panels":[]}]},"httpPath":"waiting-gateway-transaction-completed"},{"label":"Autodeposit lookup performed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/transactions/autodeposit-lookup-performed","routeSlug":"/docs/dev-docs/api/transactions/autodeposit-lookup-performed","metadata":{"seo":{"title":"Autodeposit lookup performed","description":"Autodeposit lookup performed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"autodeposit-lookup-performed","name":"Autodeposit lookup performed","isWebhook":true,"pointer":"/paths/autodeposit-lookup-performed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Autodeposit lookup performed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_841"}},"schemaId":"schema_841","pointer":"/paths/autodeposit-lookup-performed/post/requestBody","description":"Payload of autodeposit lookup-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"autodeposit-lookup-performed","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_841"}},"responseCodes":["2xx"],"pointer":"autodeposit-lookup-performed","href":"transactions/autodeposit-lookup-performed","openApiOperationId":"autodeposit-lookup-performed","summary":"Autodeposit lookup performed","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_841","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_841"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/autodeposit-lookup-performed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/autodeposit-lookup-performed"}],"panels":[]}]},"httpPath":"autodeposit-lookup-performed"}],"content":{"contentType":"group","meta":{"name":"Transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these operations to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set up payment instruments for payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorize and hold funds"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"capture funds"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"make payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"make payouts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refund transactions."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ready-to-pay","summary":"Ready to pay","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/postreadytopay","deprecated":false},{"title":"/transactions","summary":"Create a transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/posttransaction","deprecated":false},{"title":"/transactions","summary":"Retrieve transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/gettransactioncollection","deprecated":false},{"title":"/transactions/{id}","summary":"Retrieve a transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/gettransaction","deprecated":false},{"title":"/transactions/{id}","summary":"Update a transaction","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/transactions/patchtransaction","deprecated":false},{"title":"/payouts","summary":"Create a credit transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/postpayout","deprecated":false},{"title":"/transactions/{id}/query","summary":"Query a transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/posttransactionquery","deprecated":false},{"title":"/transactions/{id}/update","summary":"Update a transaction status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/posttransactionupdate","deprecated":false},{"title":"/transactions/{id}/refund","summary":"Refund a transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/posttransactionrefund","deprecated":false},{"title":"/payout-requests","summary":"Retrieve payout requests","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/transactions/getpayoutrequestcollection","deprecated":false},{"title":"/payout-requests","summary":"Create a payout request","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/transactions/postpayoutrequest","deprecated":false},{"title":"/payout-requests/{id}","summary":"Retrieve a payout request","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/transactions/getpayoutrequest","deprecated":false},{"title":"/payout-requests/{id}","summary":"Upsert a payout request","prefix":{"name":"put","color":"put"},"badges":[{"name":"Experimental"}],"link":"/transactions/putpayoutrequest","deprecated":false},{"title":"/payout-requests/{id}","summary":"Update a payout request","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Experimental"}],"link":"/transactions/patchpayoutrequest","deprecated":false},{"title":"/payout-requests/{id}/cancel","summary":"Cancel a payout request","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/transactions/postpayoutrequestcancellation","deprecated":false},{"title":"/payout-requests/{id}/split","summary":"Request a payout request split","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/transactions/postpayoutrequestsplit","deprecated":false},{"title":"/payout-requests/{id}/payment-instruments","summary":"Retrieve associated payment instruments","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/transactions/getpayoutrequestpaymentinstruments","deprecated":false},{"title":"/payout-request-allocations","summary":"Retrieve payout request allocations","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/transactions/getpayoutrequestallocationcollection","deprecated":false},{"title":"/payout-request-allocations","summary":"Create a payout request allocation","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/transactions/postpayoutrequestallocation","deprecated":false},{"title":"/payout-request-allocations/auto","summary":"Create an automatic payout request allocation","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/transactions/postpayoutrequestautoallocation","deprecated":false},{"title":"/payout-request-allocations/{id}","summary":"Retrieve a payout request allocation","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/transactions/getpayoutrequestallocation","deprecated":false},{"title":"/payout-request-allocations/{id}","summary":"Update allocation status","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Experimental"}],"link":"/transactions/patchpayoutrequestallocation","deprecated":false},{"title":"/payout-request-allocations/process","summary":"Initiate processing of allocations","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/transactions/postpayoutrequestallocationsprocess","deprecated":false},{"title":"/payout-request-batches","summary":"Retrieve payout request batches","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/transactions/getpayoutrequestbatchcollection","deprecated":false},{"title":"/payout-request-batches","summary":"Create a payout request batch","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/transactions/postpayoutrequestbatch","deprecated":false},{"title":"/payout-request-batches/{id}","summary":"Retrieve a payout request batch","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/transactions/getpayoutrequestbatch","deprecated":false},{"title":"/payout-request-batches/{id}","summary":"Update a payout request batch","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Experimental"}],"link":"/transactions/patchpayoutrequestbatch","deprecated":false},{"title":"/payout-request-batches/{id}","summary":"Delete a payout request batch","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Experimental"}],"link":"/transactions/deletepayoutrequestbatch","deprecated":false},{"title":"/payout-request-batches/{id}/auto-allocate","summary":"Allocate batch payout requests automatically","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/transactions/postpayoutrequestbatchautoallocate","deprecated":false},{"title":"/payout-request-batches/{id}/approve","summary":"Approve payout requests in a batch","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/transactions/postpayoutrequestbatchapprove","deprecated":false},{"title":"/payout-request-batches/{id}/block","summary":"Block batch payout requests","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/transactions/postpayoutrequestbatchblock","deprecated":false},{"title":"/payout-request-batches/{id}/payout-requests","summary":"Add requests to a payout request batch","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/transactions/postpayoutrequeststobatch","deprecated":false},{"title":"/payout-request-batches/{id}/payout-requests/remove","summary":"Remove requests from a payout request batch","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/transactions/postremovepayoutrequestsfrombatch","deprecated":false},{"title":"/payout-request-batches/{id}/unblock","summary":"Unblock payout requests in a batch","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/transactions/postpayoutrequestbatchunblock","deprecated":false},{"title":"/payout-request-batches/preview","summary":"Preview payout request batch results","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/transactions/getpayoutrequestbatchpreview","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"customer-redirected-offsite","summary":"Customer redirected offsite","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/customer-redirected-offsite","deprecated":false},{"title":"customer-returned","summary":"Customer returned","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/customer-returned","deprecated":false},{"title":"gateway-account-requested","summary":"Gateway account requested","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/gateway-account-requested","deprecated":false},{"title":"offsite-payment-completed","summary":"Offsite payment completed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/offsite-payment-completed","deprecated":false},{"title":"payout-request-canceled","summary":"Payout request canceled","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/payout-request-canceled","deprecated":false},{"title":"payout-request-created","summary":"Payout request created","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/payout-request-created","deprecated":false},{"title":"payout-request-fulfilled","summary":"Payout request fulfilled","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/payout-request-fulfilled","deprecated":false},{"title":"payout-request-modified","summary":"Payout request modified","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/payout-request-modified","deprecated":false},{"title":"ready-to-pay-requested","summary":"Ready to pay requested","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/ready-to-pay-requested","deprecated":false},{"title":"risk-score-changed","summary":"Risk score changed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/risk-score-changed","deprecated":false},{"title":"transaction-amount-discrepancy-found","summary":"Transaction amount discrepancy found","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/transaction-amount-discrepancy-found","deprecated":false},{"title":"transaction-declined","summary":"Transaction declined","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/transaction-declined","deprecated":false},{"title":"transaction-discrepancy-found","summary":"Transaction discrepancy found","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/transaction-discrepancy-found","deprecated":false},{"title":"transaction-process-requested","summary":"Transaction process requested","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/transaction-process-requested","deprecated":false},{"title":"transaction-processed","summary":"Transaction processed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/transaction-processed","deprecated":false},{"title":"transaction-reconciled","summary":"Transaction reconciled","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/transaction-reconciled","deprecated":false},{"title":"transaction-partially-refunded","summary":"Transaction partially refunded","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/transaction-partially-refunded","deprecated":false},{"title":"transaction-refunded","summary":"Transaction refunded","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/transaction-refunded","deprecated":false},{"title":"transaction-voided","summary":"Transaction voided","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/transaction-voided","deprecated":false},{"title":"transaction-timeout-resolved","summary":"Transaction timeout resolved","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/transaction-timeout-resolved","deprecated":false},{"title":"waiting-gateway-transaction-completed","summary":"Waiting gateway transaction completed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/waiting-gateway-transaction-completed","deprecated":false},{"title":"autodeposit-lookup-performed","summary":"Autodeposit lookup performed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/autodeposit-lookup-performed","deprecated":false}]}]}]}]}},{"type":"group","label":"Disputes","link":"/docs/dev-docs/api/disputes","routeSlug":"/docs/dev-docs/api/disputes","items":[{"label":"Retrieve disputes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/disputes/getdisputecollection","routeSlug":"/docs/dev-docs/api/disputes/getdisputecollection","metadata":{"seo":{"title":"Retrieve disputes","description":"Retrieves a list of all disputes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetDisputeCollection","name":"Retrieve disputes","isWebhook":false,"pointer":"/paths/~1disputes/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve disputes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all disputes."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."},{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1disputes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/disputes","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"q","in":"query","schemaId":"schema_782"},{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/disputes","href":"disputes/getdisputecollection","openApiOperationId":"GetDisputeCollection","summary":"Retrieve disputes","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$disputes = $client->disputes()->search([\n 'filter' => 'transactionId:testId',\n]);\n"},{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.disputes.getAll();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100, sort: '-createdTime'};\nconst secondCollection = await api.disputes.getAll(params);\n\n// access the collection items, each item is a Dispute\nsecondCollection.items.forEach(dispute => console.log(dispute.fields.transactionId));\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$disputesPaginator = $service->disputes()->getAllPaginator(filter: 'transactionId:testId', limit: 5);\nforeach ($disputesPaginator as $disputesPage) {\n printf(\"Disputes page %d/%d\\n\", $disputesPaginator->key() + 1, $disputesPaginator->count());\n foreach ($disputesPage as $dispute) {\n printf(\"Dispute #%s (%s)\\n\", $dispute->getId(), $dispute->getStatus());\n }\n}\n\n// OR\n\n$disputes = $service->disputes()->getAll(filter: 'transactionId:testId');\nforeach ($disputes as $dispute) {\n printf(\"Dispute #%s (%s)\\n\", $dispute->getId(), $dispute->getStatus());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of disputes successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_842"}},"schemaId":"schema_842","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1disputes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_842","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_842"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/getdisputecollection"}],"panels":[]}]},"httpPath":"/disputes"},{"label":"Create a dispute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/disputes/postdispute","routeSlug":"/docs/dev-docs/api/disputes/postdispute","metadata":{"seo":{"title":"Create a dispute","description":"Creates a new dispute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostDispute","name":"Create a dispute","isWebhook":false,"pointer":"/paths/~1disputes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a dispute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new dispute."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_843"}},"schemaId":"schema_843","pointer":"/paths/~1disputes/post/requestBody","description":"Dispute resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/disputes","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_843"}},"responseCodes":["201","401","403","422","429"],"pointer":"/disputes","href":"disputes/postdispute","openApiOperationId":"PostDispute","summary":"Create a dispute","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$disputeForm = new Rebilly\\Entities\\Dispute();\n$disputeForm->setTransactionId('transactionId');\n$disputeForm->setCurrency('USD');\n$disputeForm->setAmount(10);\n$disputeForm->setReasonCode(1000);\n$disputeForm->setType($disputeForm::TYPE_1CB);\n$disputeForm->setStatus($disputeForm::STATUS_RESPONSE_NEEDED);\n$disputeForm->setPostedTime('2025-01-01 05:00:00');\n\ntry {\n $dispute = $client->disputes()->create($disputeForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the properties for the new dispute\nconst data = {\n transactionId: 'my-transaction-id',\n currency: 'USD',\n amount: 5,\n reasonCode: '1000',\n type: 'first-chargeback',\n status: 'response-needed',\n acquirerReferenceNumber: '143543',\n postedTime: '2017-09-19T20:46:48Z',\n deadlineTime: '2017-09-19T20:46:48Z'\n};\n\n// the ID is optional\nconst firstdispute = await api.disputes.create({data});\n\n// or you can provide one\nconst secondDispute = await api.disputes.create({id: 'my-second-id', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$disputeForm = new \\Rebilly\\Sdk\\Model\\PostDisputeRequest();\n$disputeForm->setTransactionId('transactionId');\n$disputeForm->setCurrency('USD');\n$disputeForm->setAmount(10);\n$disputeForm->setReasonCode('1000');\n$disputeForm->setType($disputeForm::TYPE_INFORMATION_REQUEST);\n$disputeForm->setStatus($disputeForm::STATUS_RESPONSE_NEEDED);\n$disputeForm->setPostedTime('2025-01-01 05:00:00');\n\ntry {\n $dispute = $service->disputes()->create($disputeForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_843","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_843"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Dispute created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute"}},"schemaId":"components/schemas/Dispute","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1disputes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Dispute","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/postdispute"}],"panels":[]}]},"httpPath":"/disputes"},{"label":"Retrieve a dispute","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/disputes/getdispute","routeSlug":"/docs/dev-docs/api/disputes/getdispute","metadata":{"seo":{"title":"Retrieve a dispute","description":"Retrieves a dispute with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetDispute","name":"Retrieve a dispute","isWebhook":false,"pointer":"/paths/~1disputes~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a dispute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a dispute with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1disputes~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/disputes/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/disputes/{id}","href":"disputes/getdispute","openApiOperationId":"GetDispute","summary":"Retrieve a dispute","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$dispute = $client->disputes()->load('disputeId');\n"},{"lang":"JavaScript","source":"const dispute = await api.disputes.get({id: 'foobar-001'});\nconsole.log(dispute.fields.firstName);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$dispute = $service->disputes()->get('disputeId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dispute retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute"}},"schemaId":"components/schemas/Dispute"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1disputes~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Dispute","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/getdispute"}],"panels":[]}]},"httpPath":"/disputes/{id}"},{"label":"Upsert a dispute","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/disputes/putdispute","routeSlug":"/docs/dev-docs/api/disputes/putdispute","metadata":{"seo":{"title":"Upsert a dispute","description":"Creates or updates (upserts) a dispute with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutDispute","name":"Upsert a dispute","isWebhook":false,"pointer":"/paths/~1disputes~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a dispute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates (upserts) a dispute with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1disputes~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_843"}},"schemaId":"schema_843","pointer":"/paths/~1disputes~1{id}/put/requestBody","description":"Dispute resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/disputes/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_843"}},"responseCodes":["200","201","401","403","422","429"],"pointer":"/disputes/{id}","href":"disputes/putdispute","openApiOperationId":"PutDispute","summary":"Upsert a dispute","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$disputeForm = new Rebilly\\Entities\\Dispute();\n$disputeForm->setTransactionId('transactionId');\n$disputeForm->setCurrency('USD');\n$disputeForm->setAmount(10);\n$disputeForm->setReasonCode(1000);\n$disputeForm->setType($disputeForm::TYPE_1CB);\n$disputeForm->setStatus($disputeForm::STATUS_RESPONSE_NEEDED);\n$disputeForm->setPostedTime('2025-01-01 05:00:00');\n\ntry {\n $dispute = $client->disputes()->update('disputeId', $dispute);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// creating a dispute\nconst data = {\n transactionId: 'my-transaction-id',\n currency: 'USD',\n amount: 5,\n reasonCode: '1000',\n type: 'first-chargeback',\n status: 'response-needed',\n acquirerReferenceNumber: '143543',\n postedTime: '2017-09-19T20:46:48Z',\n deadlineTime: '2017-09-19T20:46:48Z'\n};\n\n// the ID is optional\nconst firstdispute = await api.disputes.create({data});\n\n// or you can provide one\nconst secondDispute = await api.disputes.create({id: 'my-second-id', data});\n\n\n\n// updating a dispute\nconst data = {\n transactionId: 'my-other-transaction-id',\n currency: 'USD',\n amount: 5,\n reasonCode: '1000',\n type: 'first-chargeback',\n status: 'response-needed',\n acquirerReferenceNumber: '143543',\n postedTime: '2017-09-19T20:46:48Z',\n deadlineTime: '2017-09-19T20:46:48Z'\n};\n\nconst dispute = await api.disputes.update({id: 'my-second-id', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$disputeForm = new \\Rebilly\\Sdk\\Model\\PostDisputeRequest();\n$disputeForm->setTransactionId('transactionId');\n$disputeForm->setCurrency('USD');\n$disputeForm->setAmount(10);\n$disputeForm->setReasonCode('1000');\n$disputeForm->setType($disputeForm::TYPE_INFORMATION_REQUEST);\n$disputeForm->setStatus($disputeForm::STATUS_RESPONSE_NEEDED);\n$disputeForm->setPostedTime('2025-01-01 05:00:00');\n\ntry {\n $dispute = $service->disputes()->update('disputeId', $disputeForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_843","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_843"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dispute updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute"}},"schemaId":"components/schemas/Dispute","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Dispute created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute"}},"schemaId":"components/schemas/Dispute","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1disputes~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Dispute","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute"}}},{"code":"201","schemaId":"components/schemas/Dispute","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/putdispute"}],"panels":[]}]},"httpPath":"/disputes/{id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Dispute created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/disputes/dispute-created","routeSlug":"/docs/dev-docs/api/disputes/dispute-created","metadata":{"seo":{"title":"Dispute created","description":"Dispute created"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"dispute-created","name":"Dispute created","isWebhook":true,"pointer":"/paths/dispute-created/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dispute created","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_844"}},"schemaId":"schema_844","pointer":"/paths/dispute-created/post/requestBody","description":"Payload of dispute-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"dispute-created","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_844"}},"responseCodes":["2xx"],"pointer":"dispute-created","href":"disputes/dispute-created","openApiOperationId":"dispute-created","summary":"Dispute created","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_844","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_844"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/dispute-created/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/dispute-created"}],"panels":[]}]},"httpPath":"dispute-created"},{"label":"Dispute modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/disputes/dispute-modified","routeSlug":"/docs/dev-docs/api/disputes/dispute-modified","metadata":{"seo":{"title":"Dispute modified","description":"Dispute modified"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"dispute-modified","name":"Dispute modified","isWebhook":true,"pointer":"/paths/dispute-modified/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dispute modified","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_844"}},"schemaId":"schema_844","pointer":"/paths/dispute-modified/post/requestBody","description":"Payload of dispute-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"dispute-modified","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_844"}},"responseCodes":["2xx"],"pointer":"dispute-modified","href":"disputes/dispute-modified","openApiOperationId":"dispute-modified","summary":"Dispute modified","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_844","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_844"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/dispute-modified/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/dispute-modified"}],"panels":[]}]},"httpPath":"dispute-modified"}],"content":{"contentType":"group","meta":{"name":"Disputes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Disputes","showPageActions":true},{"nodeType":"markdoc","content":"Use these operations to manage disputes.\nA dispute occurs when a customer contests a charge to their account.\nThe dispute and related information is made available to the merchant by the bank or credit card company.\nThe merchant then has the option to represent the charge and win the case.\nThis process is called dispute resolution.\nIf the merchant is unable to represent the charge, the card issuer typically reverses the sale and adds fees on top of the charge.\nThis process is called a chargeback."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/disputes","summary":"Retrieve disputes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disputes/getdisputecollection","deprecated":false},{"title":"/disputes","summary":"Create a dispute","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disputes/postdispute","deprecated":false},{"title":"/disputes/{id}","summary":"Retrieve a dispute","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disputes/getdispute","deprecated":false},{"title":"/disputes/{id}","summary":"Upsert a dispute","prefix":{"name":"put","color":"put"},"badges":[],"link":"/disputes/putdispute","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"dispute-created","summary":"Dispute created","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disputes/dispute-created","deprecated":false},{"title":"dispute-modified","summary":"Dispute modified","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disputes/dispute-modified","deprecated":false}]}]}]}]}},{"type":"group","label":"Fees","link":"/docs/dev-docs/api/fees","routeSlug":"/docs/dev-docs/api/fees","items":[{"label":"Retrieve fee entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/fees/getfeecollection","routeSlug":"/docs/dev-docs/api/fees/getfeecollection","metadata":{"seo":{"title":"Retrieve fee entries","description":"Retrieves a list of fee entries."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetFeeCollection","name":"Retrieve fee entries","isWebhook":false,"pointer":"/paths/~1fees/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve fee entries","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a list of fee entries."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This operation is experimental and may not be backward compatible."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1fees/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fees","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/fees","href":"fees/getfeecollection","openApiOperationId":"GetFeeCollection","summary":"Retrieve fee entries","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of fee entries retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_845"}},"schemaId":"schema_845","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1fees/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_845","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_845"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/getfeecollection"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/fees"},{"label":"Create a fee entry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/fees/postfee","routeSlug":"/docs/dev-docs/api/fees/postfee","metadata":{"seo":{"title":"Create a fee entry","description":"Creates a fee entry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostFee","name":"Create a fee entry","isWebhook":false,"pointer":"/paths/~1fees/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a fee entry","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a fee entry."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This operation is experimental and may not be backward compatible."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees/post/requestBody/content/application~1json/examples/stripe-trx","paths/~1fees/post/requestBody/content/application~1json/examples/stripe-us","paths/~1fees/post/requestBody/content/application~1json/examples/stripe-intl"]}},"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees/post/requestBody/content/application~1json/examples/stripe-trx","paths/~1fees/post/requestBody/content/application~1json/examples/stripe-us","paths/~1fees/post/requestBody/content/application~1json/examples/stripe-intl"],"pointer":"/paths/~1fees/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fees","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees/post/requestBody/content/application~1json/examples/stripe-trx","paths/~1fees/post/requestBody/content/application~1json/examples/stripe-us","paths/~1fees/post/requestBody/content/application~1json/examples/stripe-intl"]}},"responseCodes":["201","401","403","422","429"],"pointer":"/fees","href":"fees/postfee","openApiOperationId":"PostFee","summary":"Create a fee entry","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees/post/requestBody/content/application~1json/examples/stripe-trx","paths/~1fees/post/requestBody/content/application~1json/examples/stripe-us","paths/~1fees/post/requestBody/content/application~1json/examples/stripe-intl"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees/post/requestBody/content/application~1json/examples/stripe-trx","paths/~1fees/post/requestBody/content/application~1json/examples/stripe-us","paths/~1fees/post/requestBody/content/application~1json/examples/stripe-intl"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Fee entry created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees/post/responses/201/content/application~1json/examples/stripe-trx","paths/~1fees/post/responses/201/content/application~1json/examples/stripe-us","paths/~1fees/post/responses/201/content/application~1json/examples/stripe-intl"]}},"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees/post/responses/201/content/application~1json/examples/stripe-trx","paths/~1fees/post/responses/201/content/application~1json/examples/stripe-us","paths/~1fees/post/responses/201/content/application~1json/examples/stripe-intl"],"headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1fees/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees/post/responses/201/content/application~1json/examples/stripe-trx","paths/~1fees/post/responses/201/content/application~1json/examples/stripe-us","paths/~1fees/post/responses/201/content/application~1json/examples/stripe-intl"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees/post/responses/201/content/application~1json/examples/stripe-trx","paths/~1fees/post/responses/201/content/application~1json/examples/stripe-us","paths/~1fees/post/responses/201/content/application~1json/examples/stripe-intl"]}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/postfee"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/fees"},{"label":"Retrieve a fee entry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/fees/getfee","routeSlug":"/docs/dev-docs/api/fees/getfee","metadata":{"seo":{"title":"Retrieve a fee entry","description":"Retrieves a fee entry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetFee","name":"Retrieve a fee entry","isWebhook":false,"pointer":"/paths/~1fees~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a fee entry","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a fee entry."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This operation is experimental and may not be backward compatible."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1fees~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fees/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/fees/{id}","href":"fees/getfee","openApiOperationId":"GetFee","summary":"Retrieve a fee entry","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Fee retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-intl"]}},"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-intl"]},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1fees~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-intl"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-intl"]}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/getfee"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/fees/{id}"},{"label":"Upsert a fee entry","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/fees/putfee","routeSlug":"/docs/dev-docs/api/fees/putfee","metadata":{"seo":{"title":"Upsert a fee entry","description":"Creates or updates (upserts) a fee entry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutFee","name":"Upsert a fee entry","isWebhook":false,"pointer":"/paths/~1fees~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a fee entry","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates or updates (upserts) a fee entry."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This operation is experimental and may not be backward compatible."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1fees~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-intl"]}},"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-intl"],"pointer":"/paths/~1fees~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/fees/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-intl"]}},"responseCodes":["200","201","401","403","422","429"],"pointer":"/fees/{id}","href":"fees/putfee","openApiOperationId":"PutFee","summary":"Upsert a fee entry","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-intl"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-intl"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Fee entry updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-intl"]}},"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-intl"]},{"code":"201","description":"Fee entry created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-intl"]}},"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-intl"],"headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1fees~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-intl"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-intl"]}}},{"code":"201","schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-intl"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-intl"]}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/putfee"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/fees/{id}"},{"label":"Patch a fee entry","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/fees/patchfee","routeSlug":"/docs/dev-docs/api/fees/patchfee","metadata":{"seo":{"title":"Patch a fee entry","description":"Patches a fee entry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PatchFee","name":"Patch a fee entry","isWebhook":false,"pointer":"/paths/~1fees~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch a fee entry","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Patches a fee entry."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This operation is experimental and may not be backward compatible."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1fees~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchFee","exampleIds":["paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-intl"]}},"schemaId":"components/schemas/PatchFee","exampleIds":["paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-intl"],"pointer":"/paths/~1fees~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/fees/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchFee","exampleIds":["paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-intl"]}},"responseCodes":["200","401","403","422","429"],"pointer":"/fees/{id}","href":"fees/patchfee","openApiOperationId":"PatchFee","summary":"Patch a fee entry","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/PatchFee","exampleIds":["paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-intl"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchFee","exampleIds":["paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-intl"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Fee entry patched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-intl"]}},"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-intl"]},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1fees~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-intl"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee","exampleIds":["paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-trx","paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-us","paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-intl"]}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/patchfee"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/fees/{id}"},{"label":"Delete a fee entry","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/fees/deletefee","routeSlug":"/docs/dev-docs/api/fees/deletefee","metadata":{"seo":{"title":"Delete a fee entry","description":"Deletes a fee entry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteFee","name":"Delete a fee entry","isWebhook":false,"pointer":"/paths/~1fees~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a fee entry","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a fee entry."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This operation is experimental and may not be backward compatible."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1fees~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/fees/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","429"],"pointer":"/fees/{id}","href":"fees/deletefee","openApiOperationId":"DeleteFee","summary":"Delete a fee entry","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Fee deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1fees~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/deletefee"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/fees/{id}"}],"content":{"contentType":"group","meta":{"name":"Fees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fees","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use fees to reconcile transactions with applicable fees and discount rates."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fees are not applied directly to transaction amounts, they do not modify the transaction amount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fees help to describe each part of the transaction amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" These operations are experimental and may change."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/fees","summary":"Retrieve fee entries","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/fees/getfeecollection","deprecated":false},{"title":"/fees","summary":"Create a fee entry","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/fees/postfee","deprecated":false},{"title":"/fees/{id}","summary":"Retrieve a fee entry","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/fees/getfee","deprecated":false},{"title":"/fees/{id}","summary":"Upsert a fee entry","prefix":{"name":"put","color":"put"},"badges":[{"name":"Experimental"}],"link":"/fees/putfee","deprecated":false},{"title":"/fees/{id}","summary":"Patch a fee entry","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Experimental"}],"link":"/fees/patchfee","deprecated":false},{"title":"/fees/{id}","summary":"Delete a fee entry","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Experimental"}],"link":"/fees/deletefee","deprecated":false}]}]}]}]}},{"type":"group","label":"Transactions timeline","link":"/docs/dev-docs/api/transactions-timeline","routeSlug":"/docs/dev-docs/api/transactions-timeline","items":[{"label":"Retrieve transaction timeline messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions-timeline/gettransactiontimelinecollection","routeSlug":"/docs/dev-docs/api/transactions-timeline/gettransactiontimelinecollection","metadata":{"seo":{"title":"Retrieve transaction timeline messages","description":"Retrieves a list of transaction timeline messages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTransactionTimelineCollection","name":"Retrieve transaction timeline messages","isWebhook":false,"pointer":"/paths/~1transactions~1{id}~1timeline/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve transaction timeline messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of transaction timeline messages."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1transactions~1{id}~1timeline/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."}],"pointer":"/paths/~1transactions~1{id}~1timeline/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions/{id}/timeline","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"q","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/transactions/{id}/timeline","href":"transactions-timeline/gettransactiontimelinecollection","openApiOperationId":"GetTransactionTimelineCollection","summary":"Retrieve transaction timeline messages","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// all parameters are optional except for the `id`\nconst firstCollection = await api.transactions\n .getAllTimelineMessages({id: 'my-transaction'});\n\n// alternatively you can specify one or more of them\nconst params = {id: 'my-transaction', limit: 20, offset: 100};\nconst secondCollection = await api.transactions.getAllTimelineMessages(params);\n\n// access the collection items, each item is a TransactionTimeline\nsecondCollection.items\n .forEach(message => console.log(message.fields.eventType));\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of transaction timeline messages retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_846"}},"schemaId":"schema_846","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1transactions~1{id}~1timeline/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_846","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_846"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions-timeline/gettransactiontimelinecollection"}],"panels":[]}]},"httpPath":"/transactions/{id}/timeline"},{"label":"Create a transaction timeline comment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions-timeline/posttransactiontimeline","routeSlug":"/docs/dev-docs/api/transactions-timeline/posttransactiontimeline","metadata":{"seo":{"title":"Create a transaction timeline comment","description":"Creates a transaction timeline comment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostTransactionTimeline","name":"Create a transaction timeline comment","isWebhook":false,"pointer":"/paths/~1transactions~1{id}~1timeline/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a transaction timeline comment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a transaction timeline comment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1transactions~1{id}~1timeline/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionTimeline"}},"schemaId":"components/schemas/TransactionTimeline","pointer":"/paths/~1transactions~1{id}~1timeline/post/requestBody","description":"Transaction timeline resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transactions/{id}/timeline","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransactionTimeline"}},"responseCodes":["201","401","403","422","429"],"pointer":"/transactions/{id}/timeline","href":"transactions-timeline/posttransactiontimeline","openApiOperationId":"PostTransactionTimeline","summary":"Create a transaction timeline comment","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// Create a comment\nconst firstComment = await api\n .transactions.createTimelineComment({id: 'my-transaction-id', data: {message: 'Your comment here'}});\n\n// Using params object, mentions and references\nconst message = `Example of mentions @user@mydomain.com and references #transactions-transaction-id`;\nconst params = {\n id: 'my-transaction-id',\n data: {\n message,\n },\n};\nconst secondComment = await api.transactions.createTimelineComment(params);"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/TransactionTimeline","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionTimeline"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Transaction timeline comment created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionTimeline"}},"schemaId":"components/schemas/TransactionTimeline","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1transactions~1{id}~1timeline/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TransactionTimeline","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionTimeline"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions-timeline/posttransactiontimeline"}],"panels":[]}]},"httpPath":"/transactions/{id}/timeline"},{"label":"Retrieve a transaction Timeline message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions-timeline/gettransactiontimeline","routeSlug":"/docs/dev-docs/api/transactions-timeline/gettransactiontimeline","metadata":{"seo":{"title":"Retrieve a transaction Timeline message","description":"Retrieves a timeline message with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTransactionTimeline","name":"Retrieve a transaction Timeline message","isWebhook":false,"pointer":"/paths/~1transactions~1{id}~1timeline~1{messageId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a transaction Timeline message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a timeline message with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"messageId","in":"path","schemaId":"schema_782","description":"ID of the transaction timeline message.","required":true}],"pointer":"/paths/~1transactions~1{id}~1timeline~1{messageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions/{id}/timeline/{messageId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"messageId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/transactions/{id}/timeline/{messageId}","href":"transactions-timeline/gettransactiontimeline","openApiOperationId":"GetTransactionTimeline","summary":"Retrieve a transaction Timeline message","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const message = await api.transactions\n .getTimelineMessage({id: 'foobar-001', messageId: 'message-202'});\nconsole.log(message.fields.eventType);"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Timeline message retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionTimeline"}},"schemaId":"components/schemas/TransactionTimeline"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1transactions~1{id}~1timeline~1{messageId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransactionTimeline","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionTimeline"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions-timeline/gettransactiontimeline"}],"panels":[]}]},"httpPath":"/transactions/{id}/timeline/{messageId}"},{"label":"Delete a transaction timeline message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions-timeline/deletetransactiontimeline","routeSlug":"/docs/dev-docs/api/transactions-timeline/deletetransactiontimeline","metadata":{"seo":{"title":"Delete a transaction timeline message","description":"Deletes a transaction timeline message with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteTransactionTimeline","name":"Delete a transaction timeline message","isWebhook":false,"pointer":"/paths/~1transactions~1{id}~1timeline~1{messageId}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a transaction timeline message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a transaction timeline message with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"messageId","in":"path","schemaId":"schema_782","description":"ID of the transaction timeline message.","required":true}],"pointer":"/paths/~1transactions~1{id}~1timeline~1{messageId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/transactions/{id}/timeline/{messageId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"messageId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","409","429"],"pointer":"/transactions/{id}/timeline/{messageId}","href":"transactions-timeline/deletetransactiontimeline","openApiOperationId":"DeleteTransactionTimeline","summary":"Delete a transaction timeline message","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const request = await api.transactions\n .deleteTimelineMessage({id: 'foobar-001', messageId: 'message-202'});\n\n// the request does not return any fields but\n// you can confirm the success using the status code\nconsole.log(request.response.status); // 204"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Transaction timeline message deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1transactions~1{id}~1timeline~1{messageId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions-timeline/deletetransactiontimeline"}],"panels":[]}]},"httpPath":"/transactions/{id}/timeline/{messageId}"},{"label":"Retrieve payout request timeline messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions-timeline/getpayoutrequesttimelinecollection","routeSlug":"/docs/dev-docs/api/transactions-timeline/getpayoutrequesttimelinecollection","metadata":{"seo":{"title":"Retrieve payout request timeline messages","description":"Retrieves a list of payout request timeline messages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPayoutRequestTimelineCollection","name":"Retrieve payout request timeline messages","isWebhook":false,"pointer":"/paths/~1payout-requests~1{id}~1timeline/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve payout request timeline messages","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of payout request timeline messages."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-requests~1{id}~1timeline/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."}],"pointer":"/paths/~1payout-requests~1{id}~1timeline/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payout-requests/{id}/timeline","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"q","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","429"],"pointer":"/payout-requests/{id}/timeline","href":"transactions-timeline/getpayoutrequesttimelinecollection","openApiOperationId":"GetPayoutRequestTimelineCollection","summary":"Retrieve payout request timeline messages","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of payout request timeline messages retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_847"}},"schemaId":"schema_847","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-requests~1{id}~1timeline/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_847","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_847"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions-timeline/getpayoutrequesttimelinecollection"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}/timeline"},{"label":"Create a payout request timeline comment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions-timeline/postpayoutrequesttimeline","routeSlug":"/docs/dev-docs/api/transactions-timeline/postpayoutrequesttimeline","metadata":{"seo":{"title":"Create a payout request timeline comment","description":"Creates a payout request timeline comment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPayoutRequestTimeline","name":"Create a payout request timeline comment","isWebhook":false,"pointer":"/paths/~1payout-requests~1{id}~1timeline/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a payout request timeline comment","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a payout request timeline comment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1payout-requests~1{id}~1timeline/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayoutRequestTimelineMessage"}},"schemaId":"components/schemas/PayoutRequestTimelineMessage","pointer":"/paths/~1payout-requests~1{id}~1timeline/post/requestBody","description":"Payout request timeline resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payout-requests/{id}/timeline","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PayoutRequestTimelineMessage"}},"responseCodes":["201","401","403","422","429"],"pointer":"/payout-requests/{id}/timeline","href":"transactions-timeline/postpayoutrequesttimeline","openApiOperationId":"PostPayoutRequestTimeline","summary":"Create a payout request timeline comment","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/PayoutRequestTimelineMessage","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayoutRequestTimelineMessage"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Payout request timeline comment created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestTimelineMessage"}},"schemaId":"components/schemas/PayoutRequestTimelineMessage","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-requests~1{id}~1timeline/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PayoutRequestTimelineMessage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestTimelineMessage"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions-timeline/postpayoutrequesttimeline"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}/timeline"},{"label":"Retrieve a payout request timeline message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions-timeline/getpayoutrequesttimelinemessage","routeSlug":"/docs/dev-docs/api/transactions-timeline/getpayoutrequesttimelinemessage","metadata":{"seo":{"title":"Retrieve a payout request timeline message","description":"Retrieves a payout request timeline message with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPayoutRequestTimelineMessage","name":"Retrieve a payout request timeline message","isWebhook":false,"pointer":"/paths/~1payout-requests~1{id}~1timeline~1{messageId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payout request timeline message","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a payout request timeline message with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"messageId","in":"path","schemaId":"schema_782","description":"ID of the timeline message.","required":true}],"pointer":"/paths/~1payout-requests~1{id}~1timeline~1{messageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payout-requests/{id}/timeline/{messageId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"messageId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","429"],"pointer":"/payout-requests/{id}/timeline/{messageId}","href":"transactions-timeline/getpayoutrequesttimelinemessage","openApiOperationId":"GetPayoutRequestTimelineMessage","summary":"Retrieve a payout request timeline message","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payout request timeline message retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestTimelineMessage"}},"schemaId":"components/schemas/PayoutRequestTimelineMessage"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-requests~1{id}~1timeline~1{messageId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutRequestTimelineMessage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutRequestTimelineMessage"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions-timeline/getpayoutrequesttimelinemessage"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}/timeline/{messageId}"},{"label":"Delete a payout request timeline message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/transactions-timeline/deletepayoutrequesttimelinemessage","routeSlug":"/docs/dev-docs/api/transactions-timeline/deletepayoutrequesttimelinemessage","metadata":{"seo":{"title":"Delete a payout request timeline message","description":"Deletes a payout request timeline message with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePayoutRequestTimelineMessage","name":"Delete a payout request timeline message","isWebhook":false,"pointer":"/paths/~1payout-requests~1{id}~1timeline~1{messageId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a payout request timeline message","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a payout request timeline message with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"messageId","in":"path","schemaId":"schema_782","description":"ID of the timeline message.","required":true}],"pointer":"/paths/~1payout-requests~1{id}~1timeline~1{messageId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/payout-requests/{id}/timeline/{messageId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"messageId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","429"],"pointer":"/payout-requests/{id}/timeline/{messageId}","href":"transactions-timeline/deletepayoutrequesttimelinemessage","openApiOperationId":"DeletePayoutRequestTimelineMessage","summary":"Delete a payout request timeline message","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Payout request timeline message deleted."},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1payout-requests~1{id}~1timeline~1{messageId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions-timeline/deletepayoutrequesttimelinemessage"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/payout-requests/{id}/timeline/{messageId}"}],"content":{"contentType":"group","meta":{"name":"Transactions timeline"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions timeline","showPageActions":true},{"nodeType":"markdoc","content":"Use transaction timelines to maintain an audit trail of changes and activity for each transaction."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transactions/{id}/timeline","summary":"Retrieve transaction timeline messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions-timeline/gettransactiontimelinecollection","deprecated":false},{"title":"/transactions/{id}/timeline","summary":"Create a transaction timeline comment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions-timeline/posttransactiontimeline","deprecated":false},{"title":"/transactions/{id}/timeline/{messageId}","summary":"Retrieve a transaction Timeline message","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions-timeline/gettransactiontimeline","deprecated":false},{"title":"/transactions/{id}/timeline/{messageId}","summary":"Delete a transaction timeline message","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/transactions-timeline/deletetransactiontimeline","deprecated":false},{"title":"/payout-requests/{id}/timeline","summary":"Retrieve payout request timeline messages","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/transactions-timeline/getpayoutrequesttimelinecollection","deprecated":false},{"title":"/payout-requests/{id}/timeline","summary":"Create a payout request timeline comment","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/transactions-timeline/postpayoutrequesttimeline","deprecated":false},{"title":"/payout-requests/{id}/timeline/{messageId}","summary":"Retrieve a payout request timeline message","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/transactions-timeline/getpayoutrequesttimelinemessage","deprecated":false},{"title":"/payout-requests/{id}/timeline/{messageId}","summary":"Delete a payout request timeline message","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Experimental"}],"link":"/transactions-timeline/deletepayoutrequesttimelinemessage","deprecated":false}]}]}]}]}},{"type":"separator","label":"Orders & Invoices","content":null},{"type":"group","label":"Orders","link":"/docs/dev-docs/api/orders","routeSlug":"/docs/dev-docs/api/orders","items":[{"label":"Retrieve orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptioncollection","routeSlug":"/docs/dev-docs/api/orders/getsubscriptioncollection","metadata":{"seo":{"title":"Retrieve orders","description":"Retrieves a list of orders."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetSubscriptionCollection","name":"Retrieve orders","isWebhook":false,"pointer":"/paths/~1subscriptions/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of orders."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."},{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expand a response to receive a full related object in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To expand multiple objects, use a comma-separated list."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand=recentInvoice,initialInvoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available arguments are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"leadSource"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"website"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingRate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initialInvoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recentInvoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upcomingInvoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrument"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"q","in":"query","schemaId":"schema_782"},{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/subscriptions","href":"orders/getsubscriptioncollection","openApiOperationId":"GetSubscriptionCollection","summary":"Retrieve orders","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$subscriptions = $client->subscriptions()->search([\n 'filter' => 'customerId:testCustomerId',\n]);\n"},{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.subscriptions.getAll();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100, sort: '-createdTime'};\nconst secondCollection = await api.subscriptions.getAll(params);\n\n// access the collection items, each item is a Subscription\nsecondCollection.items.forEach(subscription => console.log(subscription.fields.customerId));\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$ordersPaginator = $service->subscriptions()->getAllPaginator(filter: 'customerId:testCustomerId');\nforeach ($ordersPaginator as $orderPage) {\n printf(\"Orders page %d/%d\\n\", $ordersPaginator->key() + 1, $ordersPaginator->count());\n foreach ($orderPage as $order) {\n printf(\"Order #%s (%s): %s\\n\", $order->getId(), $order->getOrderType(), $order->getStatus());\n }\n}\n\n// OR\n\n$orders = $service->subscriptions()->getAll(filter: 'customerId:testCustomerId', limit: 10);\nforeach ($orders as $order) {\n printf(\"Order #%s (%s): %s\\n\", $order->getId(), $order->getOrderType(), $order->getStatus());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of orders retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_848"}},"schemaId":"schema_848","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_848","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_848"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getsubscriptioncollection"}],"panels":[]}]},"httpPath":"/subscriptions"},{"label":"Create an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postsubscription","routeSlug":"/docs/dev-docs/api/orders/postsubscription","metadata":{"seo":{"title":"Create an order","description":"Creates an order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostSubscription","name":"Create an order","isWebhook":false,"pointer":"/paths/~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create or update an order with a specified ID, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../PutSubscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upsert an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expand a response to receive a full related object in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To expand multiple objects, use a comma-separated list."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand=recentInvoice,initialInvoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available arguments are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"leadSource"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"website"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingRate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initialInvoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recentInvoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upcomingInvoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrument"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}},"schemaId":"components/schemas/SubscriptionOrOneTimeSale","pointer":"/paths/~1subscriptions/post/requestBody","description":"Order resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}},"responseCodes":["201","401","403","422","429"],"pointer":"/subscriptions","href":"orders/postsubscription","openApiOperationId":"PostSubscription","summary":"Create an order","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$subscriptionForm = new Rebilly\\Entities\\Subscription();\n$subscriptionForm->setCustomerId('customerId');\n$subscriptionForm->setWebsiteId('websiteId');\n$subscriptionForm->setItems([\n [\n 'planId' => 'my-plan',\n 'quantity' => 1,\n ],\n]);\n$subscriptionForm->setBillingAddress([\n 'firstName' => 'John',\n 'lastName' => 'Doe',\n 'organization' => 'Test LTD',\n 'address' => 'Test street 5',\n 'address2' => 'Test house 5',\n 'city' => 'New York',\n 'region' => 'Long Island',\n 'country' => 'US',\n 'postalCode' => '123456',\n 'emails' => [\n [\n 'label' => 'main',\n 'value' => 'johndoe@testemail.com',\n 'primary' => true,\n ],\n [\n 'label' => 'secondary',\n 'value' => 'otheremail@testemail.com',\n ],\n ],\n 'phoneNumbers' => [\n [\n 'label' => 'work',\n 'value' => '+123456789',\n 'primary' => true,\n ],\n [\n 'label' => 'home',\n 'value' => '+9874654321',\n ],\n ],\n]);\n\ntry {\n $subscription = $client->subscriptions()->create($subscriptionForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the properties for the new subscription\nconst data = {\n customerId: 'foobar-0001',\n websiteId: 'my-main-website',\n items: [\n { plan: { id: 'my-plan-id' }, quantity: 1 },\n ],\n // you can append this subscription to\n // an existing invoice by passing its ID\n initialInvoiceId: 'my-existing-invoice-id',\n billingAddress: {\n firstName: 'Johnny',\n lastName: 'Brown',\n emails: [{\n label: 'main',\n value: 'johnny+test@grr.la',\n primary: true\n }],\n },\n deliveryAddress: {\n firstName: 'Johnny',\n lastName: 'Brown',\n emails: [{\n label: 'main',\n value: 'johnny+test@grr.la',\n primary: true\n }],\n },\n customFields: {}\n};\n\n// the ID is optional\nconst firstInvoice = await api.subscriptions.create({data});\n\n// or you can provide one\nconst secondInvoice = await api.subscriptions.create({id: 'my-second-id', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$order = \\Rebilly\\Sdk\\Model\\Subscription::from()\n ->setWebsiteId('websiteId')\n ->setCustomerId('customerId')\n ->setItems([\n \\Rebilly\\Sdk\\Model\\SubscriptionOrOneTimeSaleItem::from()\n ->setPlan(\n \\Rebilly\\Sdk\\Model\\OriginalPlan::from()\n ->setId('planId')\n )\n ->setQuantity(1),\n ]);\n\ntry {\n $order = $service->subscriptions()->create($order);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/SubscriptionOrOneTimeSale","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Order created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}},"schemaId":"components/schemas/SubscriptionOrOneTimeSale","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/SubscriptionOrOneTimeSale","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/postsubscription"}],"panels":[]}]},"httpPath":"/subscriptions"},{"label":"Retrieve an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscription","routeSlug":"/docs/dev-docs/api/orders/getsubscription","metadata":{"seo":{"title":"Retrieve an order","description":"Retrieves an order with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetSubscription","name":"Retrieve an order","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an order with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscriptions~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expand a response to receive a full related object in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To expand multiple objects, use a comma-separated list."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand=recentInvoice,initialInvoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available arguments are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"leadSource"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"website"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingRate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initialInvoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recentInvoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upcomingInvoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrument"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscriptions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/subscriptions/{id}","href":"orders/getsubscription","openApiOperationId":"GetSubscription","summary":"Retrieve an order","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$subscription = $client->subscriptions()->load('subscriptionId');\n"},{"lang":"JavaScript","source":"const subscription = await api.subscriptions.get({id: 'foobar-001'});\nconsole.log(subscription.fields.billingAddress.firstName);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$order = $service->subscriptions()->get('orderId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}},"schemaId":"components/schemas/SubscriptionOrOneTimeSale"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1subscriptions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionOrOneTimeSale","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getsubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}"},{"label":"Upsert an order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/putsubscription","routeSlug":"/docs/dev-docs/api/orders/putsubscription","metadata":{"seo":{"title":"Upsert an order","description":"Creates or updates (upserts) an order with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutSubscription","name":"Upsert an order","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates (upserts) an order with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscriptions~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expand a response to receive a full related object in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To expand multiple objects, use a comma-separated list."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand=recentInvoice,initialInvoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available arguments are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"leadSource"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"website"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingRate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initialInvoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recentInvoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upcomingInvoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrument"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscriptions~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}},"schemaId":"components/schemas/SubscriptionOrOneTimeSale","pointer":"/paths/~1subscriptions~1{id}/put/requestBody","description":"Order resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/subscriptions/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}},"responseCodes":["200","201","401","403","404","422","429"],"pointer":"/subscriptions/{id}","href":"orders/putsubscription","openApiOperationId":"PutSubscription","summary":"Upsert an order","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$subscriptionForm = new Rebilly\\Entities\\Subscription();\n$subscriptionForm->setCustomerId('customerId');\n$subscriptionForm->setWebsiteId('websiteId');\n$subscriptionForm->setItems($subscriptionForm->createItems([\n [\n 'planId' => 'my-plan',\n 'quantity' => 1,\n ],\n]));\n$subscriptionForm->setBillingAddress([\n 'firstName' => 'John',\n 'lastName' => 'Doe',\n 'organization' => 'Test LTD',\n 'address' => 'Test street 5',\n 'address2' => 'Test house 5',\n 'city' => 'New York',\n 'region' => 'Long Island',\n 'country' => 'US',\n 'postalCode' => '123456',\n 'emails' => [\n [\n 'label' => 'main',\n 'value' => 'johndoe@testemail.com',\n 'primary' => true,\n ],\n [\n 'label' => 'secondary',\n 'value' => 'otheremail@testemail.com',\n ],\n ],\n 'phoneNumbers' => [\n [\n 'label' => 'work',\n 'value' => '+123456789',\n 'primary' => true,\n ],\n [\n 'label' => 'home',\n 'value' => '+9874654321',\n ],\n ],\n]);\n\ntry {\n $subscription = $client->subscriptions()->update('subscriptionId', $subscriptionForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// creating a subscription\nconst data = {\n customerId: 'foobar-0001',\n websiteId: 'my-main-website',\n items: [\n { plan: { id: 'my-plan-id' }, quantity: 1 },\n ],\n // you can append this subscription to\n // an existing invoice by passing its ID\n initialInvoiceId: 'my-existing-invoice-id',\n billingAddress: {\n firstName: 'Johnny',\n lastName: 'Brown',\n emails: [{\n label: 'main',\n value: 'johnny+test@grr.la',\n primary: true\n }],\n },\n deliveryAddress: {\n firstName: 'Johnny',\n lastName: 'Brown',\n emails: [{\n label: 'main',\n value: 'johnny+test@grr.la',\n primary: true\n }],\n },\n customFields: {}\n};\n\n// the ID is optional\nconst firstInvoice = await api.subscriptions.create({data});\n\n// or you can provide one\nconst secondInvoice = await api.subscriptions.create({id: 'my-second-id', data});\n\n\n\n// updating a subscription\nconst data = {\n // determines if a payment attempt will be automatic\n autopay: false,\n // set the next renewal time\n renewalTime: '2018-09-26T15:34:29Z'\n};\n\nconst subscription = await api.subscriptions.update({id: 'my-second-id', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$order = new \\Rebilly\\Sdk\\Model\\Subscription([\n 'shipping' => new \\Rebilly\\Sdk\\Model\\ManualShipping([\n 'amount' => 14.99,\n ]),\n]);\n\ntry {\n $order = $service->subscriptions()->update('orderId', $order);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n\n// OR\n\n$order = $service->subscriptions()->get('orderId');\n$order->setShipping(new \\Rebilly\\Sdk\\Model\\ManualShipping(['amount' => 14.99]));\n\ntry {\n $order = $service->subscriptions()->update('orderId', $order);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/SubscriptionOrOneTimeSale","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}},"schemaId":"components/schemas/SubscriptionOrOneTimeSale","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Order created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}},"schemaId":"components/schemas/SubscriptionOrOneTimeSale","headers":{"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_849"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscriptions~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionOrOneTimeSale","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}}},{"code":"201","schemaId":"components/schemas/SubscriptionOrOneTimeSale","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/putsubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}"},{"label":"Delete a pending order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/deletesubscription","routeSlug":"/docs/dev-docs/api/orders/deletesubscription","metadata":{"seo":{"title":"Delete a pending order","description":"Deletes a pending order with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteSubscription","name":"Delete a pending order","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a pending order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a pending order with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscriptions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/subscriptions/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","409","429"],"pointer":"/subscriptions/{id}","href":"orders/deletesubscription","openApiOperationId":"DeleteSubscription","summary":"Delete a pending order","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$service->subscriptions()->delete('orderId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Pending order deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscriptions~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/deletesubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}"},{"label":"Void a subscription order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postsubscriptionvoid","routeSlug":"/docs/dev-docs/api/orders/postsubscriptionvoid","metadata":{"seo":{"title":"Void a subscription order","description":"Voids a pending order with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostSubscriptionVoid","name":"Void a subscription order","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1void/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Void a subscription order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Voids a pending order with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1void/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions/{id}/void","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","401","403","404","409","429"],"pointer":"/subscriptions/{id}/void","href":"orders/postsubscriptionvoid","openApiOperationId":"PostSubscriptionVoid","summary":"Void a subscription order","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$subscription = $client->subscriptions()->void('subscriptionId');\n"},{"lang":"JavaScript","source":"const voidedSubscription = await api.subscriptions.void({id: 'my-subscription-id'});\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$order = $service->subscriptions()->void('orderId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Order voided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}},"schemaId":"components/schemas/SubscriptionOrOneTimeSale","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscriptions~1{id}~1void/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/SubscriptionOrOneTimeSale","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/postsubscriptionvoid"}],"panels":[]}]},"httpPath":"/subscriptions/{id}/void"},{"label":"Change subscription order items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postsubscriptionitemschange","routeSlug":"/docs/dev-docs/api/orders/postsubscriptionitemschange","metadata":{"seo":{"title":"Change subscription order items","description":"Changes subscription order items or quantities, and designates if or when pro-rata credits should be given."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostSubscriptionItemsChange","name":"Change subscription order items","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1change-items/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change subscription order items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Changes subscription order items or quantities, and designates if or when pro-rata credits should be given."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1change-items/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expand a response to receive a full related object in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To expand multiple objects, use a comma-separated list."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand=recentInvoice,initialInvoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available arguments are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"leadSource"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"website"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingRate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initialInvoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recentInvoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upcomingInvoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrument"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscriptions~1{id}~1change-items/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionChange"}},"schemaId":"components/schemas/SubscriptionChange","pointer":"/paths/~1subscriptions~1{id}~1change-items/post/requestBody","description":"Change items request."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions/{id}/change-items","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriptionChange"}},"responseCodes":["201","401","403","422","429"],"pointer":"/subscriptions/{id}/change-items","href":"orders/postsubscriptionitemschange","openApiOperationId":"PostSubscriptionItemsChange","summary":"Change subscription order items","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/SubscriptionChange","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionChange"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Order changed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}},"schemaId":"components/schemas/SubscriptionOrOneTimeSale","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscriptions~1{id}~1change-items/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/SubscriptionOrOneTimeSale","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSale"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/postsubscriptionitemschange"}],"panels":[]}]},"httpPath":"/subscriptions/{id}/change-items"},{"label":"Update a subscription order item","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/patchsubscriptionitem","routeSlug":"/docs/dev-docs/api/orders/patchsubscriptionitem","metadata":{"seo":{"title":"Update a subscription order item","description":"Updates a subscription order item. This is an experimental endpoint and may be changed or removed in the future."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PatchSubscriptionItem","name":"Update a subscription order item","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1items~1{itemId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a subscription order item","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a subscription order item.\nThis is an experimental endpoint and may be changed or removed in the future."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"itemId","in":"path","schemaId":"schema_782","description":"ID of the subscription item.","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1items~1{itemId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderItemUpdate"}},"schemaId":"components/schemas/OrderItemUpdate","pointer":"/paths/~1subscriptions~1{id}~1items~1{itemId}/patch/requestBody","description":"Update item request."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/subscriptions/{id}/items/{itemId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"itemId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderItemUpdate"}},"responseCodes":["200","401","403","422","429"],"pointer":"/subscriptions/{id}/items/{itemId}","href":"orders/patchsubscriptionitem","openApiOperationId":"PatchSubscriptionItem","summary":"Update a subscription order item","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const data = {\n quantityFilled: 4,\n};\n\nconst subscription = await api.subscription.updateItem({\n id: \"subscription-id\",\n itemId: \"item-id\",\n data,\n});\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/OrderItemUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderItemUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order item updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSaleItem"}},"schemaId":"components/schemas/SubscriptionOrOneTimeSaleItem","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscriptions~1{id}~1items~1{itemId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionOrOneTimeSaleItem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionOrOneTimeSaleItem"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/patchsubscriptionitem"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/subscriptions/{id}/items/{itemId}"},{"label":"Issue an interim invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postsubscriptioninteriminvoice","routeSlug":"/docs/dev-docs/api/orders/postsubscriptioninteriminvoice","metadata":{"seo":{"title":"Issue an interim invoice","description":"Issues an interim invoice for a subscription order.Use this operation for plan changes and pro rata adjustments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostSubscriptionInterimInvoice","name":"Issue an interim invoice","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1interim-invoice/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue an interim invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issues an interim invoice for a subscription order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this operation for plan changes and pro rata adjustments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This process:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds the subscription line items to the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issues the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optionally, applies payment to the invoice if a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supplied."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1interim-invoice/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionInvoice"}},"schemaId":"components/schemas/SubscriptionInvoice","pointer":"/paths/~1subscriptions~1{id}~1interim-invoice/post/requestBody","description":"Issue an interim invoice."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions/{id}/interim-invoice","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriptionInvoice"}},"responseCodes":["201","401","403","422","429"],"pointer":"/subscriptions/{id}/interim-invoice","href":"orders/postsubscriptioninteriminvoice","openApiOperationId":"PostSubscriptionInterimInvoice","summary":"Issue an interim invoice","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/SubscriptionInvoice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionInvoice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Invoice created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscriptions~1{id}~1interim-invoice/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/postsubscriptioninteriminvoice"}],"panels":[]}]},"httpPath":"/subscriptions/{id}/interim-invoice"},{"label":"Retrieve subscription order pauses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptionpausecollection","routeSlug":"/docs/dev-docs/api/orders/getsubscriptionpausecollection","metadata":{"seo":{"title":"Retrieve subscription order pauses","description":"Retrieves a list of subscription order pauses."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetSubscriptionPauseCollection","name":"Retrieve subscription order pauses","isWebhook":false,"pointer":"/paths/~1subscription-pauses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve subscription order pauses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of subscription order pauses."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscription-pauses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription-pauses","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/subscription-pauses","href":"orders/getsubscriptionpausecollection","openApiOperationId":"GetSubscriptionPauseCollection","summary":"Retrieve subscription order pauses","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of subscription order pauses retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_850"}},"schemaId":"schema_850","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1subscription-pauses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_850","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_850"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getsubscriptionpausecollection"}],"panels":[]}]},"httpPath":"/subscription-pauses"},{"label":"Pause a subscription order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postsubscriptionpause","routeSlug":"/docs/dev-docs/api/orders/postsubscriptionpause","metadata":{"seo":{"title":"Pause a subscription order","description":"Pauses a subscription order with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostSubscriptionPause","name":"Pause a subscription order","isWebhook":false,"pointer":"/paths/~1subscription-pauses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pause a subscription order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Pauses a subscription order with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionPause"}},"schemaId":"components/schemas/SubscriptionPause","pointer":"/paths/~1subscription-pauses/post/requestBody","description":"Pause resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscription-pauses","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriptionPause"}},"responseCodes":["201","401","403","422","429"],"pointer":"/subscription-pauses","href":"orders/postsubscriptionpause","openApiOperationId":"PostSubscriptionPause","summary":"Pause a subscription order","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/SubscriptionPause","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionPause"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Pause created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionPause"}},"schemaId":"components/schemas/SubscriptionPause","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscription-pauses/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/SubscriptionPause","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionPause"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/postsubscriptionpause"}],"panels":[]}]},"httpPath":"/subscription-pauses"},{"label":"Retrieve a subscription order pause","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptionpause","routeSlug":"/docs/dev-docs/api/orders/getsubscriptionpause","metadata":{"seo":{"title":"Retrieve a subscription order pause","description":"Retrieves a subscription order pause with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetSubscriptionPause","name":"Retrieve a subscription order pause","isWebhook":false,"pointer":"/paths/~1subscription-pauses~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a subscription order pause","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a subscription order pause with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscription-pauses~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription-pauses/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/subscription-pauses/{id}","href":"orders/getsubscriptionpause","openApiOperationId":"GetSubscriptionPause","summary":"Retrieve a subscription order pause","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pause retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionPause"}},"schemaId":"components/schemas/SubscriptionPause"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1subscription-pauses~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionPause","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionPause"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getsubscriptionpause"}],"panels":[]}]},"httpPath":"/subscription-pauses/{id}"},{"label":"Update a subscription order pause","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/putsubscriptionpause","routeSlug":"/docs/dev-docs/api/orders/putsubscriptionpause","metadata":{"seo":{"title":"Update a subscription order pause","description":"Updates a subscription order pause."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutSubscriptionPause","name":"Update a subscription order pause","isWebhook":false,"pointer":"/paths/~1subscription-pauses~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a subscription order pause","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a subscription order pause."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscription-pauses~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionPause"}},"schemaId":"components/schemas/SubscriptionPause","pointer":"/paths/~1subscription-pauses~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/subscription-pauses/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriptionPause"}},"responseCodes":["200","201","401","403","422","429"],"pointer":"/subscription-pauses/{id}","href":"orders/putsubscriptionpause","openApiOperationId":"PutSubscriptionPause","summary":"Update a subscription order pause","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/SubscriptionPause","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionPause"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pause updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionPause"}},"schemaId":"components/schemas/SubscriptionPause","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Pause created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionPause"}},"schemaId":"components/schemas/SubscriptionPause","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscription-pauses~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionPause","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionPause"}}},{"code":"201","schemaId":"components/schemas/SubscriptionPause","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionPause"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/putsubscriptionpause"}],"panels":[]}]},"httpPath":"/subscription-pauses/{id}"},{"label":"Delete a subscription order pause","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/deletesubscriptionpause","routeSlug":"/docs/dev-docs/api/orders/deletesubscriptionpause","metadata":{"seo":{"title":"Delete a subscription order pause","description":"Deletes a subscription order pause with a specified ID.If the specified pause is pending, it is revoked.If the specified pause is ongoing, it is finished."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteSubscriptionPause","name":"Delete a subscription order pause","isWebhook":false,"pointer":"/paths/~1subscription-pauses~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a subscription order pause","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a subscription order pause with a specified ID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the specified pause is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revoked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the specified pause is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ongoing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"finished"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscription-pauses~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/subscription-pauses/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","409","429"],"pointer":"/subscription-pauses/{id}","href":"orders/deletesubscriptionpause","openApiOperationId":"DeleteSubscriptionPause","summary":"Delete a subscription order pause","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Subscription order pause revoked or finished.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscription-pauses~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/deletesubscriptionpause"}],"panels":[]}]},"httpPath":"/subscription-pauses/{id}"},{"label":"Retrieve subscription order cancellations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptioncancellationcollection","routeSlug":"/docs/dev-docs/api/orders/getsubscriptioncancellationcollection","metadata":{"seo":{"title":"Retrieve subscription order cancellations","description":"Retrieves a list of subscription order cancellations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetSubscriptionCancellationCollection","name":"Retrieve subscription order cancellations","isWebhook":false,"pointer":"/paths/~1subscription-cancellations/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve subscription order cancellations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of subscription order cancellations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscription-cancellations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription-cancellations","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/subscription-cancellations","href":"orders/getsubscriptioncancellationcollection","openApiOperationId":"GetSubscriptionCancellationCollection","summary":"Retrieve subscription order cancellations","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$cancellationsPaginator = $service->subscriptionCancellations()->getAllPaginator(\n filter: 'reason:' . \\Rebilly\\Sdk\\Model\\SubscriptionCancellation::REASON_CONTRACT_EXPIRED,\n);\nforeach ($cancellationsPaginator as $cancellationPage) {\n printf(\"Cancellations page %d/%d\\n\", $cancellationsPaginator->key() + 1, $cancellationsPaginator->count());\n foreach ($cancellationPage as $cancellation) {\n printf(\n \"Cancellation #%s (%s): %s\\n\",\n $cancellation->getId(),\n $cancellation->getStatus(),\n $cancellation->getSubscriptionId(),\n );\n }\n}\n\n// OR\n\n$cancellations = $service->subscriptionCancellations()->getAll(\n filter: 'reason:' . \\Rebilly\\Sdk\\Model\\SubscriptionCancellation::REASON_CONTRACT_EXPIRED,\n limit: 10,\n);\nforeach ($cancellations as $cancellation) {\n printf(\n \"Cancellation #%s (%s): %s\\n\",\n $cancellation->getId(),\n $cancellation->getStatus(),\n $cancellation->getSubscriptionId(),\n );\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of canceled subscription orders retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_851"}},"schemaId":"schema_851","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1subscription-cancellations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_851","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_851"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getsubscriptioncancellationcollection"}],"panels":[]}]},"httpPath":"/subscription-cancellations"},{"label":"Cancel a subscription order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postsubscriptioncancellation","routeSlug":"/docs/dev-docs/api/orders/postsubscriptioncancellation","metadata":{"seo":{"title":"Cancel a subscription order","description":"Cancels a subscription order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostSubscriptionCancellation","name":"Cancel a subscription order","isWebhook":false,"pointer":"/paths/~1subscription-cancellations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a subscription order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels a subscription order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionCancellation"}},"schemaId":"components/schemas/SubscriptionCancellation","pointer":"/paths/~1subscription-cancellations/post/requestBody","description":"Cancellation resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscription-cancellations","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriptionCancellation"}},"responseCodes":["201","401","403","422","429"],"pointer":"/subscription-cancellations","href":"orders/postsubscriptioncancellation","openApiOperationId":"PostSubscriptionCancellation","summary":"Cancel a subscription order","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$subscriptionCancellationForm = new Rebilly\\Entities\\SubscriptionCancellation();\n$subscriptionCancellationForm->setSubscriptionId('subscription-1');\n$subscriptionCancellationForm->setChurnTime(date('c'));\n\ntry {\n $subscription = $client->subscriptionCancellations()->create($subscriptionCancellationForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"const data = {\n subscriptionId: 'sub_01HRF27SATGE4Z6PBJE6PD8328',\n churnTime: '2020-06-10T13:55:51Z',\n}\n\n// the ID is optional\nconst firstSubscriptionCancellation = await api.subscriptionCancellations.create({data});\n\n// or you can provide one\nconst secondSubscriptionCancellation = await api.subscriptionCancellations.create({id: 'custom-cancellation-id', data});\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$cancellation = new \\Rebilly\\Sdk\\Model\\SubscriptionCancellation([\n 'subscriptionId' => 'subscriptionId',\n 'churnTime' => new \\DateTimeImmutable(),\n 'canceledBy' => \\Rebilly\\Sdk\\Model\\SubscriptionCancellation::CANCELED_BY_MERCHANT,\n 'reason' => \\Rebilly\\Sdk\\Model\\SubscriptionCancellation::REASON_CONTRACT_EXPIRED,\n]);\n\ntry {\n $cancellation = $service->subscriptionCancellations()->create($cancellation);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/SubscriptionCancellation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionCancellation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Cancellation created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionCancellation"}},"schemaId":"components/schemas/SubscriptionCancellation","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscription-cancellations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/SubscriptionCancellation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionCancellation"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/postsubscriptioncancellation"}],"panels":[]}]},"httpPath":"/subscription-cancellations"},{"label":"Retrieve a subscription order cancellation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptioncancellation","routeSlug":"/docs/dev-docs/api/orders/getsubscriptioncancellation","metadata":{"seo":{"title":"Retrieve a subscription order cancellation","description":"Retrieves a subscription order cancellation with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetSubscriptionCancellation","name":"Retrieve a subscription order cancellation","isWebhook":false,"pointer":"/paths/~1subscription-cancellations~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a subscription order cancellation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a subscription order cancellation with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscription-cancellations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription-cancellations/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/subscription-cancellations/{id}","href":"orders/getsubscriptioncancellation","openApiOperationId":"GetSubscriptionCancellation","summary":"Retrieve a subscription order cancellation","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$cancellation = $service->subscriptionCancellations()->get('cancellationId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription order cancellation retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionCancellation"}},"schemaId":"components/schemas/SubscriptionCancellation"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1subscription-cancellations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionCancellation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionCancellation"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getsubscriptioncancellation"}],"panels":[]}]},"httpPath":"/subscription-cancellations/{id}"},{"label":"Upsert a subscription order cancellation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/putsubscriptioncancellation","routeSlug":"/docs/dev-docs/api/orders/putsubscriptioncancellation","metadata":{"seo":{"title":"Upsert a subscription order cancellation","description":"Creates or updates (upserts) a subscription order cancellation with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutSubscriptionCancellation","name":"Upsert a subscription order cancellation","isWebhook":false,"pointer":"/paths/~1subscription-cancellations~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a subscription order cancellation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates (upserts) a subscription order cancellation with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscription-cancellations~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionCancellation"}},"schemaId":"components/schemas/SubscriptionCancellation","pointer":"/paths/~1subscription-cancellations~1{id}/put/requestBody","description":"Cancellation resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/subscription-cancellations/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriptionCancellation"}},"responseCodes":["200","201","401","403","422","429"],"pointer":"/subscription-cancellations/{id}","href":"orders/putsubscriptioncancellation","openApiOperationId":"PutSubscriptionCancellation","summary":"Upsert a subscription order cancellation","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const data = {\n subscriptionId: 'sub_01HRF27SATGE4Z6PBJE6PD8328',\n churnTime: '2020-06-10T13:55:51Z',\n}\n\n// the ID is optional\nconst firstSubscriptionCancellation = await api.subscriptionCancellations.create({data});\n\n// or you can provide one\nconst secondSubscriptionCancellation = await api.subscriptionCancellations.create({id: 'custom-cancellation-id', data});\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$cancellation = new \\Rebilly\\Sdk\\Model\\SubscriptionCancellation([\n 'subscriptionId' => 'subscriptionId',\n 'churnTime' => new \\DateTimeImmutable(),\n 'canceledBy' => \\Rebilly\\Sdk\\Model\\SubscriptionCancellation::CANCELED_BY_MERCHANT,\n 'reason' => \\Rebilly\\Sdk\\Model\\SubscriptionCancellation::REASON_CONTRACT_EXPIRED,\n]);\n\ntry {\n $cancellation = $service->subscriptionCancellations()->update('cancellationId', $cancellation);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/SubscriptionCancellation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionCancellation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cancellation updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionCancellation"}},"schemaId":"components/schemas/SubscriptionCancellation","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Cancellation created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionCancellation"}},"schemaId":"components/schemas/SubscriptionCancellation","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscription-cancellations~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionCancellation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionCancellation"}}},{"code":"201","schemaId":"components/schemas/SubscriptionCancellation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionCancellation"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/putsubscriptioncancellation"}],"panels":[]}]},"httpPath":"/subscription-cancellations/{id}"},{"label":"Update a subscription order cancellation","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/patchsubscriptioncancellation","routeSlug":"/docs/dev-docs/api/orders/patchsubscriptioncancellation","metadata":{"seo":{"title":"Update a subscription order cancellation","description":"Updates a subscription order cancellation with a specified ID. Use this operation to update a cancellation reason and description."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PatchSubscriptionCancellation","name":"Update a subscription order cancellation","isWebhook":false,"pointer":"/paths/~1subscription-cancellations~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a subscription order cancellation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a subscription order cancellation with a specified ID.\nUse this operation to update a cancellation reason and description."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscription-cancellations~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_852"}},"schemaId":"schema_852","pointer":"/paths/~1subscription-cancellations~1{id}/patch/requestBody","description":"Patch cancellation resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/subscription-cancellations/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_852"}},"responseCodes":["200","401","403","422","429"],"pointer":"/subscription-cancellations/{id}","href":"orders/patchsubscriptioncancellation","openApiOperationId":"PatchSubscriptionCancellation","summary":"Update a subscription order cancellation","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$cancellation = new \\Rebilly\\Sdk\\Model\\PatchSubscriptionCancellationRequest([\n 'reason' => \\Rebilly\\Sdk\\Model\\PatchSubscriptionCancellationRequest::REASON_CONTRACT_EXPIRED,\n]);\n\ntry {\n $cancellation = $service->subscriptionCancellations()->patch('cancellationId', $cancellation);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_852","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_852"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cancellation updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionCancellation"}},"schemaId":"components/schemas/SubscriptionCancellation","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscription-cancellations~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionCancellation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionCancellation"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/patchsubscriptioncancellation"}],"panels":[]}]},"httpPath":"/subscription-cancellations/{id}"},{"label":"Delete a subscription order cancellation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/deletesubscriptioncancellation","routeSlug":"/docs/dev-docs/api/orders/deletesubscriptioncancellation","metadata":{"seo":{"title":"Delete a subscription order cancellation","description":"Deletes a subscription order cancellation with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteSubscriptionCancellation","name":"Delete a subscription order cancellation","isWebhook":false,"pointer":"/paths/~1subscription-cancellations~1{id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a subscription order cancellation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a subscription order cancellation with a specified ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only subscription order cancellations with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be deleted."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscription-cancellations~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/subscription-cancellations/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","409","429"],"pointer":"/subscription-cancellations/{id}","href":"orders/deletesubscriptioncancellation","openApiOperationId":"DeleteSubscriptionCancellation","summary":"Delete a subscription order cancellation","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$service->subscriptionCancellations()->delete('cancellationId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Subscription order cancellation deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscription-cancellations~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/deletesubscriptioncancellation"}],"panels":[]}]},"httpPath":"/subscription-cancellations/{id}"},{"label":"Retrieve subscription order reactivations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptionreactivationcollection","routeSlug":"/docs/dev-docs/api/orders/getsubscriptionreactivationcollection","metadata":{"seo":{"title":"Retrieve subscription order reactivations","description":"Retrieves a list of subscription order reactivations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetSubscriptionReactivationCollection","name":"Retrieve subscription order reactivations","isWebhook":false,"pointer":"/paths/~1subscription-reactivations/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve subscription order reactivations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of subscription order reactivations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscription-reactivations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription-reactivations","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/subscription-reactivations","href":"orders/getsubscriptionreactivationcollection","openApiOperationId":"GetSubscriptionReactivationCollection","summary":"Retrieve subscription order reactivations","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.subscriptionReactivations.getAll();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100, sort: '-createdTime'};\nconst secondCollection = await api.subscriptionReactivations.getAll(params);\n\n// access the collection items, each item is a SubscriptionReactivation\nsecondCollection.items.forEach(subscription => console.log(subscription.fields.customerId));\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of subscription order reactivations retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_853"}},"schemaId":"schema_853","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1subscription-reactivations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_853","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_853"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getsubscriptionreactivationcollection"}],"panels":[]}]},"httpPath":"/subscription-reactivations"},{"label":"Reactivate a subscription order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postsubscriptionreactivation","routeSlug":"/docs/dev-docs/api/orders/postsubscriptionreactivation","metadata":{"seo":{"title":"Reactivate a subscription order","description":"Reactivates a subscription order with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostSubscriptionReactivation","name":"Reactivate a subscription order","isWebhook":false,"pointer":"/paths/~1subscription-reactivations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reactivate a subscription order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reactivates a subscription order with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionReactivation"}},"schemaId":"components/schemas/SubscriptionReactivation","pointer":"/paths/~1subscription-reactivations/post/requestBody","description":"Reactivation resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscription-reactivations","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriptionReactivation"}},"responseCodes":["201","401","403","409","422","429"],"pointer":"/subscription-reactivations","href":"orders/postsubscriptionreactivation","openApiOperationId":"PostSubscriptionReactivation","summary":"Reactivate a subscription order","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const data = {\n subscriptionId: 'sub_01HRF27SATGE4Z6PBJE6PD8328',\n description: 'reactivation-reason',\n effectiveTime: '2020-06-10T13:55:51Z',\n renewalTime: '2020-07-10T13:55:51Z'\n};\n\nconst reactivatedSubscription = await api.subscriptionReactivations.reactivate({data});\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/SubscriptionReactivation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionReactivation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reactivation created. The order is now active."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the order had a related cancellation with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it is revoked."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionReactivation"}},"schemaId":"components/schemas/SubscriptionReactivation","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscription-reactivations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/SubscriptionReactivation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionReactivation"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/postsubscriptionreactivation"}],"panels":[]}]},"httpPath":"/subscription-reactivations"},{"label":"Retrieve a subscription order reactivation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptionreactivation","routeSlug":"/docs/dev-docs/api/orders/getsubscriptionreactivation","metadata":{"seo":{"title":"Retrieve a subscription order reactivation","description":"Retrieves a subscription order reactivation with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetSubscriptionReactivation","name":"Retrieve a subscription order reactivation","isWebhook":false,"pointer":"/paths/~1subscription-reactivations~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a subscription order reactivation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a subscription order reactivation with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscription-reactivations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription-reactivations/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/subscription-reactivations/{id}","href":"orders/getsubscriptionreactivation","openApiOperationId":"GetSubscriptionReactivation","summary":"Retrieve a subscription order reactivation","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const subscription = await api.subscriptionReactivations.get({id: 'foobar-001'});\nconsole.log(subscription.fields.description);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Reactivation retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionReactivation"}},"schemaId":"components/schemas/SubscriptionReactivation"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1subscription-reactivations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionReactivation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionReactivation"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getsubscriptionreactivation"}],"panels":[]}]},"httpPath":"/subscription-reactivations/{id}"},{"label":"Retrieve an upcoming subscription order invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptionupcominginvoice","routeSlug":"/docs/dev-docs/api/orders/getsubscriptionupcominginvoice","metadata":{"seo":{"title":"Retrieve an upcoming subscription order invoice","description":"Retrieves an upcoming invoice for a specified subscription order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetSubscriptionUpcomingInvoice","name":"Retrieve an upcoming subscription order invoice","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1upcoming-invoice/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an upcoming subscription order invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves an upcoming invoice for a specified subscription order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An upcoming invoice is an invoice that has not been issued."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It functions as a preview of the next invoice for the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/invoices/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoices"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1upcoming-invoice/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscriptions~1{id}~1upcoming-invoice/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions/{id}/upcoming-invoice","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/subscriptions/{id}/upcoming-invoice","href":"orders/getsubscriptionupcominginvoice","openApiOperationId":"GetSubscriptionUpcomingInvoice","summary":"Retrieve an upcoming subscription order invoice","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Upcoming invoice retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpcomingInvoice"}},"schemaId":"components/schemas/UpcomingInvoice"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1subscriptions~1{id}~1upcoming-invoice/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpcomingInvoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpcomingInvoice"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getsubscriptionupcominginvoice"}],"panels":[]}]},"httpPath":"/subscriptions/{id}/upcoming-invoice"},{"label":"Issue an upcoming invoice for early pay","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postsubscriptionupcominginvoiceissuance","routeSlug":"/docs/dev-docs/api/orders/postsubscriptionupcominginvoiceissuance","metadata":{"seo":{"title":"Issue an upcoming invoice for early pay","description":"Issues an upcoming invoice, for a subscription order with a specified ID, for early pay."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostSubscriptionUpcomingInvoiceIssuance","name":"Issue an upcoming invoice for early pay","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1upcoming-invoice~1issue/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue an upcoming invoice for early pay","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Issues an upcoming invoice, for a subscription order with a specified ID, for early pay."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1upcoming-invoice~1issue/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceIssue"}},"schemaId":"components/schemas/InvoiceIssue","pointer":"/paths/~1subscriptions~1{id}~1upcoming-invoice~1issue/post/requestBody","description":"InvoiceIssue resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions/{id}/upcoming-invoice/issue","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceIssue"}},"responseCodes":["201","401","403","404","409","429"],"pointer":"/subscriptions/{id}/upcoming-invoice/issue","href":"orders/postsubscriptionupcominginvoiceissuance","openApiOperationId":"PostSubscriptionUpcomingInvoiceIssuance","summary":"Issue an upcoming invoice for early pay","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/InvoiceIssue","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceIssue"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Upcoming invoice issued.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpcomingInvoice"}},"schemaId":"components/schemas/UpcomingInvoice","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscriptions~1{id}~1upcoming-invoice~1issue/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/UpcomingInvoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpcomingInvoice"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/postsubscriptionupcominginvoiceissuance"}],"panels":[]}]},"httpPath":"/subscriptions/{id}/upcoming-invoice/issue"},{"label":"Preview an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postprevieworder","routeSlug":"/docs/dev-docs/api/orders/postprevieworder","metadata":{"seo":{"title":"Preview an order","description":"Previews an order. Use this operation to preview a draft order before making an order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPreviewOrder","name":"Preview an order","isWebhook":false,"pointer":"/paths/~1previews~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Previews an order.\nUse this operation to preview a draft order before making an order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderPreview"}},"schemaId":"components/schemas/OrderPreview","pointer":"/paths/~1previews~1orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/previews/orders","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderPreview"}},"responseCodes":["200","401","403","422","429"],"pointer":"/previews/orders","href":"orders/postprevieworder","openApiOperationId":"PostPreviewOrder","summary":"Preview an order","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/OrderPreview","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderPreview"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order preview retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderPreview"}},"schemaId":"components/schemas/OrderPreview","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1previews~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderPreview","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderPreview"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/postprevieworder"}],"panels":[]}]},"httpPath":"/previews/orders"},{"label":"Retrieve upcoming subscription order invoice","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/getsubscriptionupcominginvoicecollection","routeSlug":"/docs/dev-docs/api/orders/getsubscriptionupcominginvoicecollection","metadata":{"seo":{"title":"Retrieve upcoming subscription order invoice","description":"Retrieves an upcoming invoice for a specified subscription order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetSubscriptionUpcomingInvoiceCollection","name":"Retrieve upcoming subscription order invoice","deprecated":true,"isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1upcoming-invoices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve upcoming subscription order invoice","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves an upcoming invoice for a specified subscription order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is deprecated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../GetSubscriptionUpcomingInvoice"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an upcoming invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1upcoming-invoices/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscriptions~1{id}~1upcoming-invoices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions/{id}/upcoming-invoices","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/subscriptions/{id}/upcoming-invoices","href":"orders/getsubscriptionupcominginvoicecollection","openApiOperationId":"GetSubscriptionUpcomingInvoiceCollection","summary":"Retrieve upcoming subscription order invoice","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Upcoming invoices retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_854"}},"schemaId":"schema_854"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1subscriptions~1{id}~1upcoming-invoices/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_854","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_854"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getsubscriptionupcominginvoicecollection"}],"panels":[]}]},"httpPath":"/subscriptions/{id}/upcoming-invoices"},{"label":"Issue a specific upcoming invoice for early pay","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders/postupcominginvoiceissuance","routeSlug":"/docs/dev-docs/api/orders/postupcominginvoiceissuance","metadata":{"seo":{"title":"Issue a specific upcoming invoice for early pay","description":"Issues an upcoming invoice with a specified ID for early pay."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostUpcomingInvoiceIssuance","name":"Issue a specific upcoming invoice for early pay","deprecated":true,"isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1upcoming-invoices~1{invoiceId}~1issue/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue a specific upcoming invoice for early pay","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issues an upcoming invoice with a specified ID for early pay."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is deprecated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../PostSubscriptionUpcomingInvoiceIssuance"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issue an upcoming invoice for early pay"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"invoiceId","in":"path","schemaId":"schema_782","description":"ID of the upcoming invoice.","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1upcoming-invoices~1{invoiceId}~1issue/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceIssue"}},"schemaId":"components/schemas/InvoiceIssue","pointer":"/paths/~1subscriptions~1{id}~1upcoming-invoices~1{invoiceId}~1issue/post/requestBody","description":"InvoiceIssue resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions/{id}/upcoming-invoices/{invoiceId}/issue","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"invoiceId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceIssue"}},"responseCodes":["201","401","403","404","409","429"],"pointer":"/subscriptions/{id}/upcoming-invoices/{invoiceId}/issue","href":"orders/postupcominginvoiceissuance","openApiOperationId":"PostUpcomingInvoiceIssuance","summary":"Issue a specific upcoming invoice for early pay","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/InvoiceIssue","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceIssue"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Upcoming invoice issued.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpcomingInvoice"}},"schemaId":"components/schemas/UpcomingInvoice","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscriptions~1{id}~1upcoming-invoices~1{invoiceId}~1issue/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/UpcomingInvoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpcomingInvoice"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/postupcominginvoiceissuance"}],"panels":[]}]},"httpPath":"/subscriptions/{id}/upcoming-invoices/{invoiceId}/issue"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Hard usage limit reached","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/hard-usage-limit-reached","routeSlug":"/docs/dev-docs/api/orders/hard-usage-limit-reached","metadata":{"seo":{"title":"Hard usage limit reached","description":"Hard usage limit reached"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"hard-usage-limit-reached","name":"Hard usage limit reached","isWebhook":true,"pointer":"/paths/hard-usage-limit-reached/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Hard usage limit reached","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_855"}},"schemaId":"schema_855","pointer":"/paths/hard-usage-limit-reached/post/requestBody","description":"Payload of usage limit-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"hard-usage-limit-reached","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_855"}},"responseCodes":["2xx"],"pointer":"hard-usage-limit-reached","href":"orders/hard-usage-limit-reached","openApiOperationId":"hard-usage-limit-reached","summary":"Hard usage limit reached","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_855","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_855"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/hard-usage-limit-reached/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/hard-usage-limit-reached"}],"panels":[]}]},"httpPath":"hard-usage-limit-reached"},{"label":"Order abandoned reminder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/order-abandon-reminder","routeSlug":"/docs/dev-docs/api/orders/order-abandon-reminder","metadata":{"seo":{"title":"Order abandoned reminder","description":"Order abandoned reminder"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"order-abandon-reminder","name":"Order abandoned reminder","isWebhook":true,"pointer":"/paths/order-abandon-reminder/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order abandoned reminder","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_856"}},"schemaId":"schema_856","pointer":"/paths/order-abandon-reminder/post/requestBody","description":"Payload of order abandon reminder-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"order-abandon-reminder","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_856"}},"responseCodes":["2xx"],"pointer":"order-abandon-reminder","href":"orders/order-abandon-reminder","openApiOperationId":"order-abandon-reminder","summary":"Order abandoned reminder","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_856","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_856"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/order-abandon-reminder/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/order-abandon-reminder"}],"panels":[]}]},"httpPath":"order-abandon-reminder"},{"label":"Order abandoned","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/order-abandoned","routeSlug":"/docs/dev-docs/api/orders/order-abandoned","metadata":{"seo":{"title":"Order abandoned","description":"Order abandoned"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"order-abandoned","name":"Order abandoned","isWebhook":true,"pointer":"/paths/order-abandoned/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order abandoned","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/order-abandoned/post/requestBody","description":"Payload of order-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"order-abandoned","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["2xx"],"pointer":"order-abandoned","href":"orders/order-abandoned","openApiOperationId":"order-abandoned","summary":"Order abandoned","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/order-abandoned/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/order-abandoned"}],"panels":[]}]},"httpPath":"order-abandoned"},{"label":"Order completed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/order-completed","routeSlug":"/docs/dev-docs/api/orders/order-completed","metadata":{"seo":{"title":"Order completed","description":"Order completed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"order-completed","name":"Order completed","isWebhook":true,"pointer":"/paths/order-completed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order completed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/order-completed/post/requestBody","description":"Payload of order-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"order-completed","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["2xx"],"pointer":"order-completed","href":"orders/order-completed","openApiOperationId":"order-completed","summary":"Order completed","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/order-completed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/order-completed"}],"panels":[]}]},"httpPath":"order-completed"},{"label":"Renewal invoice issued","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/renewal-invoice-issued","routeSlug":"/docs/dev-docs/api/orders/renewal-invoice-issued","metadata":{"seo":{"title":"Renewal invoice issued","description":"Renewal invoice issued"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"renewal-invoice-issued","name":"Renewal invoice issued","isWebhook":true,"pointer":"/paths/renewal-invoice-issued/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Renewal invoice issued","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_858"}},"schemaId":"schema_858","pointer":"/paths/renewal-invoice-issued/post/requestBody","description":"Payload of renewal invoice-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"renewal-invoice-issued","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_858"}},"responseCodes":["2xx"],"pointer":"renewal-invoice-issued","href":"orders/renewal-invoice-issued","openApiOperationId":"renewal-invoice-issued","summary":"Renewal invoice issued","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_858","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_858"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/renewal-invoice-issued/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/renewal-invoice-issued"}],"panels":[]}]},"httpPath":"renewal-invoice-issued"},{"label":"Soft usage limit reached","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/soft-usage-limit-reached","routeSlug":"/docs/dev-docs/api/orders/soft-usage-limit-reached","metadata":{"seo":{"title":"Soft usage limit reached","description":"Soft usage limit reached"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"soft-usage-limit-reached","name":"Soft usage limit reached","isWebhook":true,"pointer":"/paths/soft-usage-limit-reached/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Soft usage limit reached","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_855"}},"schemaId":"schema_855","pointer":"/paths/soft-usage-limit-reached/post/requestBody","description":"Payload of usage limit-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"soft-usage-limit-reached","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_855"}},"responseCodes":["2xx"],"pointer":"soft-usage-limit-reached","href":"orders/soft-usage-limit-reached","openApiOperationId":"soft-usage-limit-reached","summary":"Soft usage limit reached","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_855","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_855"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/soft-usage-limit-reached/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/soft-usage-limit-reached"}],"panels":[]}]},"httpPath":"soft-usage-limit-reached"},{"label":"Subscription order activated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-activated","routeSlug":"/docs/dev-docs/api/orders/subscription-activated","metadata":{"seo":{"title":"Subscription order activated","description":"Subscription order activated"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-activated","name":"Subscription order activated","isWebhook":true,"pointer":"/paths/subscription-activated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription order activated","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/subscription-activated/post/requestBody","description":"Payload of order-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-activated","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["2xx"],"pointer":"subscription-activated","href":"orders/subscription-activated","openApiOperationId":"subscription-activated","summary":"Subscription order activated","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-activated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-activated"}],"panels":[]}]},"httpPath":"subscription-activated"},{"label":"Subscription order canceled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-canceled","routeSlug":"/docs/dev-docs/api/orders/subscription-canceled","metadata":{"seo":{"title":"Subscription order canceled","description":"Subscription order canceled"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-canceled","name":"Subscription order canceled","isWebhook":true,"pointer":"/paths/subscription-canceled/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription order canceled","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/subscription-canceled/post/requestBody","description":"Payload of order-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-canceled","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["2xx"],"pointer":"subscription-canceled","href":"orders/subscription-canceled","openApiOperationId":"subscription-canceled","summary":"Subscription order canceled","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-canceled/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-canceled"}],"panels":[]}]},"httpPath":"subscription-canceled"},{"label":"Subscription order churned","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-churned","routeSlug":"/docs/dev-docs/api/orders/subscription-churned","metadata":{"seo":{"title":"Subscription order churned","description":"Subscription order churned"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-churned","name":"Subscription order churned","isWebhook":true,"pointer":"/paths/subscription-churned/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription order churned","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/subscription-churned/post/requestBody","description":"Payload of order-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-churned","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["2xx"],"pointer":"subscription-churned","href":"orders/subscription-churned","openApiOperationId":"subscription-churned","summary":"Subscription order churned","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-churned/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-churned"}],"panels":[]}]},"httpPath":"subscription-churned"},{"label":"Subscription order created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-created","routeSlug":"/docs/dev-docs/api/orders/subscription-created","metadata":{"seo":{"title":"Subscription order created","description":"Subscription order created"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-created","name":"Subscription order created","isWebhook":true,"pointer":"/paths/subscription-created/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription order created","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/subscription-created/post/requestBody","description":"Payload of order-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-created","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["2xx"],"pointer":"subscription-created","href":"orders/subscription-created","openApiOperationId":"subscription-created","summary":"Subscription order created","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-created/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-created"}],"panels":[]}]},"httpPath":"subscription-created"},{"label":"Subscription order downgraded","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-downgraded","routeSlug":"/docs/dev-docs/api/orders/subscription-downgraded","metadata":{"seo":{"title":"Subscription order downgraded","description":"Subscription order downgraded"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-downgraded","name":"Subscription order downgraded","isWebhook":true,"pointer":"/paths/subscription-downgraded/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription order downgraded","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/subscription-downgraded/post/requestBody","description":"Payload of order-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-downgraded","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["2xx"],"pointer":"subscription-downgraded","href":"orders/subscription-downgraded","openApiOperationId":"subscription-downgraded","summary":"Subscription order downgraded","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-downgraded/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-downgraded"}],"panels":[]}]},"httpPath":"subscription-downgraded"},{"label":"Subscription items changed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-items-changed","routeSlug":"/docs/dev-docs/api/orders/subscription-items-changed","metadata":{"seo":{"title":"Subscription items changed","description":"Subscription items changed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-items-changed","name":"Subscription items changed","isWebhook":true,"pointer":"/paths/subscription-items-changed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription items changed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/subscription-items-changed/post/requestBody","description":"Payload of order-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-items-changed","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["2xx"],"pointer":"subscription-items-changed","href":"orders/subscription-items-changed","openApiOperationId":"subscription-items-changed","summary":"Subscription items changed","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-items-changed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-items-changed"}],"panels":[]}]},"httpPath":"subscription-items-changed"},{"label":"Order modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-modified","routeSlug":"/docs/dev-docs/api/orders/subscription-modified","metadata":{"seo":{"title":"Order modified","description":"Order modified"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-modified","name":"Order modified","isWebhook":true,"pointer":"/paths/subscription-modified/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order modified","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/subscription-modified/post/requestBody","description":"Payload of order-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-modified","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["2xx"],"pointer":"subscription-modified","href":"orders/subscription-modified","openApiOperationId":"subscription-modified","summary":"Order modified","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-modified/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-modified"}],"panels":[]}]},"httpPath":"subscription-modified"},{"label":"Subscription quantity filled limit reached","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-quantity-filled-limit-reached","routeSlug":"/docs/dev-docs/api/orders/subscription-quantity-filled-limit-reached","metadata":{"seo":{"title":"Subscription quantity filled limit reached","description":"Subscription quantity filled limit reached"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-quantity-filled-limit-reached","name":"Subscription quantity filled limit reached","isWebhook":true,"pointer":"/paths/subscription-quantity-filled-limit-reached/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription quantity filled limit reached","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_859"}},"schemaId":"schema_859","pointer":"/paths/subscription-quantity-filled-limit-reached/post/requestBody","description":"Payload of subscription quantity limit-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-quantity-filled-limit-reached","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_859"}},"responseCodes":["2xx"],"pointer":"subscription-quantity-filled-limit-reached","href":"orders/subscription-quantity-filled-limit-reached","openApiOperationId":"subscription-quantity-filled-limit-reached","summary":"Subscription quantity filled limit reached","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_859","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_859"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-quantity-filled-limit-reached/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-quantity-filled-limit-reached"}],"panels":[]}]},"httpPath":"subscription-quantity-filled-limit-reached"},{"label":"Subscription order reactivated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-reactivated","routeSlug":"/docs/dev-docs/api/orders/subscription-reactivated","metadata":{"seo":{"title":"Subscription order reactivated","description":"Subscription order reactivated"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-reactivated","name":"Subscription order reactivated","isWebhook":true,"pointer":"/paths/subscription-reactivated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription order reactivated","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/subscription-reactivated/post/requestBody","description":"Payload of order-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-reactivated","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["2xx"],"pointer":"subscription-reactivated","href":"orders/subscription-reactivated","openApiOperationId":"subscription-reactivated","summary":"Subscription order reactivated","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-reactivated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-reactivated"}],"panels":[]}]},"httpPath":"subscription-reactivated"},{"label":"Subscription renewal reminder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-renewal-reminder","routeSlug":"/docs/dev-docs/api/orders/subscription-renewal-reminder","metadata":{"seo":{"title":"Subscription renewal reminder","description":"Subscription renewal reminder"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-renewal-reminder","name":"Subscription renewal reminder","isWebhook":true,"pointer":"/paths/subscription-renewal-reminder/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription renewal reminder","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/subscription-renewal-reminder/post/requestBody","description":"Payload of order-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-renewal-reminder","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["2xx"],"pointer":"subscription-renewal-reminder","href":"orders/subscription-renewal-reminder","openApiOperationId":"subscription-renewal-reminder","summary":"Subscription renewal reminder","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-renewal-reminder/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-renewal-reminder"}],"panels":[]}]},"httpPath":"subscription-renewal-reminder"},{"label":"Subscription order renewed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-renewed","routeSlug":"/docs/dev-docs/api/orders/subscription-renewed","metadata":{"seo":{"title":"Subscription order renewed","description":"Subscription order renewed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-renewed","name":"Subscription order renewed","isWebhook":true,"pointer":"/paths/subscription-renewed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription order renewed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/subscription-renewed/post/requestBody","description":"Payload of order-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-renewed","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["2xx"],"pointer":"subscription-renewed","href":"orders/subscription-renewed","openApiOperationId":"subscription-renewed","summary":"Subscription order renewed","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-renewed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-renewed"}],"panels":[]}]},"httpPath":"subscription-renewed"},{"label":"Subscription order trial converted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-trial-converted","routeSlug":"/docs/dev-docs/api/orders/subscription-trial-converted","metadata":{"seo":{"title":"Subscription order trial converted","description":"Subscription order trial converted"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-trial-converted","name":"Subscription order trial converted","isWebhook":true,"pointer":"/paths/subscription-trial-converted/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription order trial converted","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/subscription-trial-converted/post/requestBody","description":"Payload of order-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-trial-converted","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["2xx"],"pointer":"subscription-trial-converted","href":"orders/subscription-trial-converted","openApiOperationId":"subscription-trial-converted","summary":"Subscription order trial converted","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-trial-converted/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-trial-converted"}],"panels":[]}]},"httpPath":"subscription-trial-converted"},{"label":"Subscription order trial end reminder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-trial-end-reminder","routeSlug":"/docs/dev-docs/api/orders/subscription-trial-end-reminder","metadata":{"seo":{"title":"Subscription order trial end reminder","description":"Subscription order trial end reminder"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-trial-end-reminder","name":"Subscription order trial end reminder","isWebhook":true,"pointer":"/paths/subscription-trial-end-reminder/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription order trial end reminder","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/subscription-trial-end-reminder/post/requestBody","description":"Payload of order-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-trial-end-reminder","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["2xx"],"pointer":"subscription-trial-end-reminder","href":"orders/subscription-trial-end-reminder","openApiOperationId":"subscription-trial-end-reminder","summary":"Subscription order trial end reminder","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-trial-end-reminder/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-trial-end-reminder"}],"panels":[]}]},"httpPath":"subscription-trial-end-reminder"},{"label":"Subscription order trial ended","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-trial-ended","routeSlug":"/docs/dev-docs/api/orders/subscription-trial-ended","metadata":{"seo":{"title":"Subscription order trial ended","description":"Subscription order trial ended"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-trial-ended","name":"Subscription order trial ended","isWebhook":true,"pointer":"/paths/subscription-trial-ended/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription order trial ended","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/subscription-trial-ended/post/requestBody","description":"Payload of order-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-trial-ended","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["2xx"],"pointer":"subscription-trial-ended","href":"orders/subscription-trial-ended","openApiOperationId":"subscription-trial-ended","summary":"Subscription order trial ended","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-trial-ended/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-trial-ended"}],"panels":[]}]},"httpPath":"subscription-trial-ended"},{"label":"Subscription order upgraded","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-upgraded","routeSlug":"/docs/dev-docs/api/orders/subscription-upgraded","metadata":{"seo":{"title":"Subscription order upgraded","description":"Subscription order upgraded"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-upgraded","name":"Subscription order upgraded","isWebhook":true,"pointer":"/paths/subscription-upgraded/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription order upgraded","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/subscription-upgraded/post/requestBody","description":"Payload of order-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-upgraded","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["2xx"],"pointer":"subscription-upgraded","href":"orders/subscription-upgraded","openApiOperationId":"subscription-upgraded","summary":"Subscription order upgraded","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-upgraded/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-upgraded"}],"panels":[]}]},"httpPath":"subscription-upgraded"},{"label":"Subscription order paused","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-paused","routeSlug":"/docs/dev-docs/api/orders/subscription-paused","metadata":{"seo":{"title":"Subscription order paused","description":"Subscription order paused"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-paused","name":"Subscription order paused","isWebhook":true,"pointer":"/paths/subscription-paused/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription order paused","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_860"}},"schemaId":"schema_860","pointer":"/paths/subscription-paused/post/requestBody","description":"Payload of subscription pause-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-paused","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_860"}},"responseCodes":["2xx"],"pointer":"subscription-paused","href":"orders/subscription-paused","openApiOperationId":"subscription-paused","summary":"Subscription order paused","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_860","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_860"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-paused/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-paused"}],"panels":[]}]},"httpPath":"subscription-paused"},{"label":"Subscription order pause created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-pause-created","routeSlug":"/docs/dev-docs/api/orders/subscription-pause-created","metadata":{"seo":{"title":"Subscription order pause created","description":"Subscription order pause created"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-pause-created","name":"Subscription order pause created","isWebhook":true,"pointer":"/paths/subscription-pause-created/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription order pause created","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_860"}},"schemaId":"schema_860","pointer":"/paths/subscription-pause-created/post/requestBody","description":"Payload of subscription pause-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-pause-created","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_860"}},"responseCodes":["2xx"],"pointer":"subscription-pause-created","href":"orders/subscription-pause-created","openApiOperationId":"subscription-pause-created","summary":"Subscription order pause created","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_860","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_860"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-pause-created/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-pause-created"}],"panels":[]}]},"httpPath":"subscription-pause-created"},{"label":"Subscription order pause modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-pause-modified","routeSlug":"/docs/dev-docs/api/orders/subscription-pause-modified","metadata":{"seo":{"title":"Subscription order pause modified","description":"Subscription order pause modified"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-pause-modified","name":"Subscription order pause modified","isWebhook":true,"pointer":"/paths/subscription-pause-modified/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription order pause modified","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_860"}},"schemaId":"schema_860","pointer":"/paths/subscription-pause-modified/post/requestBody","description":"Payload of subscription pause-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-pause-modified","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_860"}},"responseCodes":["2xx"],"pointer":"subscription-pause-modified","href":"orders/subscription-pause-modified","openApiOperationId":"subscription-pause-modified","summary":"Subscription order pause modified","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_860","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_860"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-pause-modified/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-pause-modified"}],"panels":[]}]},"httpPath":"subscription-pause-modified"},{"label":"Subscription order pause revoked","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-pause-revoked","routeSlug":"/docs/dev-docs/api/orders/subscription-pause-revoked","metadata":{"seo":{"title":"Subscription order pause revoked","description":"Subscription order pause revoked"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-pause-revoked","name":"Subscription order pause revoked","isWebhook":true,"pointer":"/paths/subscription-pause-revoked/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription order pause revoked","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_860"}},"schemaId":"schema_860","pointer":"/paths/subscription-pause-revoked/post/requestBody","description":"Payload of subscription pause-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-pause-revoked","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_860"}},"responseCodes":["2xx"],"pointer":"subscription-pause-revoked","href":"orders/subscription-pause-revoked","openApiOperationId":"subscription-pause-revoked","summary":"Subscription order pause revoked","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_860","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_860"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-pause-revoked/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-pause-revoked"}],"panels":[]}]},"httpPath":"subscription-pause-revoked"},{"label":"Subscription order resumed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/subscription-resumed","routeSlug":"/docs/dev-docs/api/orders/subscription-resumed","metadata":{"seo":{"title":"Subscription order resumed","description":"Subscription order resumed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-resumed","name":"Subscription order resumed","isWebhook":true,"pointer":"/paths/subscription-resumed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription order resumed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_860"}},"schemaId":"schema_860","pointer":"/paths/subscription-resumed/post/requestBody","description":"Payload of subscription pause-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription-resumed","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_860"}},"responseCodes":["2xx"],"pointer":"subscription-resumed","href":"orders/subscription-resumed","openApiOperationId":"subscription-resumed","summary":"Subscription order resumed","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_860","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_860"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/subscription-resumed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/subscription-resumed"}],"panels":[]}]},"httpPath":"subscription-resumed"},{"label":"Trial usage limit reached","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/trial-usage-limit-reached","routeSlug":"/docs/dev-docs/api/orders/trial-usage-limit-reached","metadata":{"seo":{"title":"Trial usage limit reached","description":"Trial usage limit reached"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"trial-usage-limit-reached","name":"Trial usage limit reached","isWebhook":true,"pointer":"/paths/trial-usage-limit-reached/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trial usage limit reached","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_855"}},"schemaId":"schema_855","pointer":"/paths/trial-usage-limit-reached/post/requestBody","description":"Payload of usage limit-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"trial-usage-limit-reached","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_855"}},"responseCodes":["2xx"],"pointer":"trial-usage-limit-reached","href":"orders/trial-usage-limit-reached","openApiOperationId":"trial-usage-limit-reached","summary":"Trial usage limit reached","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_855","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_855"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/trial-usage-limit-reached/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/trial-usage-limit-reached"}],"panels":[]}]},"httpPath":"trial-usage-limit-reached"},{"label":"Order delinquency time reached","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/orders/order-delinquency-reached","routeSlug":"/docs/dev-docs/api/orders/order-delinquency-reached","metadata":{"seo":{"title":"Order delinquency time reached","description":"Order delinquency time reached"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"order-delinquency-reached","name":"Order delinquency time reached","isWebhook":true,"pointer":"/paths/order-delinquency-reached/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order delinquency time reached","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/order-delinquency-reached/post/requestBody","description":"Payload of order-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"order-delinquency-reached","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["2xx"],"pointer":"order-delinquency-reached","href":"orders/order-delinquency-reached","openApiOperationId":"order-delinquency-reached","summary":"Order delinquency time reached","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/order-delinquency-reached/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/order-delinquency-reached"}],"panels":[]}]},"httpPath":"order-delinquency-reached"}],"content":{"contentType":"group","meta":{"name":"Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these operations to manage customer orders."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An order is a customer's request to purchase items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It can contain subscription and one-time sale items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an order contains one or more subscription items, it is a subscription order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An order generates an invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A subscription order generates an invoice for each service period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/concepts/#orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscriptions","summary":"Retrieve orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getsubscriptioncollection","deprecated":false},{"title":"/subscriptions","summary":"Create an order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/postsubscription","deprecated":false},{"title":"/subscriptions/{id}","summary":"Retrieve an order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getsubscription","deprecated":false},{"title":"/subscriptions/{id}","summary":"Upsert an order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/putsubscription","deprecated":false},{"title":"/subscriptions/{id}","summary":"Delete a pending order","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/orders/deletesubscription","deprecated":false},{"title":"/subscriptions/{id}/void","summary":"Void a subscription order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/postsubscriptionvoid","deprecated":false},{"title":"/subscriptions/{id}/change-items","summary":"Change subscription order items","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/postsubscriptionitemschange","deprecated":false},{"title":"/subscriptions/{id}/items/{itemId}","summary":"Update a subscription order item","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Experimental"}],"link":"/orders/patchsubscriptionitem","deprecated":false},{"title":"/subscriptions/{id}/interim-invoice","summary":"Issue an interim invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/postsubscriptioninteriminvoice","deprecated":false},{"title":"/subscription-pauses","summary":"Retrieve subscription order pauses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getsubscriptionpausecollection","deprecated":false},{"title":"/subscription-pauses","summary":"Pause a subscription order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/postsubscriptionpause","deprecated":false},{"title":"/subscription-pauses/{id}","summary":"Retrieve a subscription order pause","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getsubscriptionpause","deprecated":false},{"title":"/subscription-pauses/{id}","summary":"Update a subscription order pause","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/putsubscriptionpause","deprecated":false},{"title":"/subscription-pauses/{id}","summary":"Delete a subscription order pause","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/orders/deletesubscriptionpause","deprecated":false},{"title":"/subscription-cancellations","summary":"Retrieve subscription order cancellations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getsubscriptioncancellationcollection","deprecated":false},{"title":"/subscription-cancellations","summary":"Cancel a subscription order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/postsubscriptioncancellation","deprecated":false},{"title":"/subscription-cancellations/{id}","summary":"Retrieve a subscription order cancellation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getsubscriptioncancellation","deprecated":false},{"title":"/subscription-cancellations/{id}","summary":"Upsert a subscription order cancellation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/putsubscriptioncancellation","deprecated":false},{"title":"/subscription-cancellations/{id}","summary":"Update a subscription order cancellation","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/orders/patchsubscriptioncancellation","deprecated":false},{"title":"/subscription-cancellations/{id}","summary":"Delete a subscription order cancellation","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/orders/deletesubscriptioncancellation","deprecated":false},{"title":"/subscription-reactivations","summary":"Retrieve subscription order reactivations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getsubscriptionreactivationcollection","deprecated":false},{"title":"/subscription-reactivations","summary":"Reactivate a subscription order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/postsubscriptionreactivation","deprecated":false},{"title":"/subscription-reactivations/{id}","summary":"Retrieve a subscription order reactivation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getsubscriptionreactivation","deprecated":false},{"title":"/subscriptions/{id}/upcoming-invoice","summary":"Retrieve an upcoming subscription order invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getsubscriptionupcominginvoice","deprecated":false},{"title":"/subscriptions/{id}/upcoming-invoice/issue","summary":"Issue an upcoming invoice for early pay","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/postsubscriptionupcominginvoiceissuance","deprecated":false},{"title":"/previews/orders","summary":"Preview an order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/postprevieworder","deprecated":false},{"title":"/subscriptions/{id}/upcoming-invoices","summary":"Retrieve upcoming subscription order invoice","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/orders/getsubscriptionupcominginvoicecollection","deprecated":true},{"title":"/subscriptions/{id}/upcoming-invoices/{invoiceId}/issue","summary":"Issue a specific upcoming invoice for early pay","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/orders/postupcominginvoiceissuance","deprecated":true}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"hard-usage-limit-reached","summary":"Hard usage limit reached","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/hard-usage-limit-reached","deprecated":false},{"title":"order-abandon-reminder","summary":"Order abandoned reminder","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/order-abandon-reminder","deprecated":false},{"title":"order-abandoned","summary":"Order abandoned","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/order-abandoned","deprecated":false},{"title":"order-completed","summary":"Order completed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/order-completed","deprecated":false},{"title":"renewal-invoice-issued","summary":"Renewal invoice issued","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/renewal-invoice-issued","deprecated":false},{"title":"soft-usage-limit-reached","summary":"Soft usage limit reached","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/soft-usage-limit-reached","deprecated":false},{"title":"subscription-activated","summary":"Subscription order activated","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-activated","deprecated":false},{"title":"subscription-canceled","summary":"Subscription order canceled","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-canceled","deprecated":false},{"title":"subscription-churned","summary":"Subscription order churned","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-churned","deprecated":false},{"title":"subscription-created","summary":"Subscription order created","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-created","deprecated":false},{"title":"subscription-downgraded","summary":"Subscription order downgraded","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-downgraded","deprecated":false},{"title":"subscription-items-changed","summary":"Subscription items changed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-items-changed","deprecated":false},{"title":"subscription-modified","summary":"Order modified","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-modified","deprecated":false},{"title":"subscription-quantity-filled-limit-reached","summary":"Subscription quantity filled limit reached","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-quantity-filled-limit-reached","deprecated":false},{"title":"subscription-reactivated","summary":"Subscription order reactivated","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-reactivated","deprecated":false},{"title":"subscription-renewal-reminder","summary":"Subscription renewal reminder","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-renewal-reminder","deprecated":false},{"title":"subscription-renewed","summary":"Subscription order renewed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-renewed","deprecated":false},{"title":"subscription-trial-converted","summary":"Subscription order trial converted","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-trial-converted","deprecated":false},{"title":"subscription-trial-end-reminder","summary":"Subscription order trial end reminder","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-trial-end-reminder","deprecated":false},{"title":"subscription-trial-ended","summary":"Subscription order trial ended","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-trial-ended","deprecated":false},{"title":"subscription-upgraded","summary":"Subscription order upgraded","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-upgraded","deprecated":false},{"title":"subscription-paused","summary":"Subscription order paused","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-paused","deprecated":false},{"title":"subscription-pause-created","summary":"Subscription order pause created","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-pause-created","deprecated":false},{"title":"subscription-pause-modified","summary":"Subscription order pause modified","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-pause-modified","deprecated":false},{"title":"subscription-pause-revoked","summary":"Subscription order pause revoked","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-pause-revoked","deprecated":false},{"title":"subscription-resumed","summary":"Subscription order resumed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/subscription-resumed","deprecated":false},{"title":"trial-usage-limit-reached","summary":"Trial usage limit reached","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/trial-usage-limit-reached","deprecated":false},{"title":"order-delinquency-reached","summary":"Order delinquency time reached","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/order-delinquency-reached","deprecated":false}]}]}]}]}},{"type":"group","label":"Invoices","link":"/docs/dev-docs/api/invoices","routeSlug":"/docs/dev-docs/api/invoices","items":[{"label":"Retrieve invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/getinvoicecollection","routeSlug":"/docs/dev-docs/api/invoices/getinvoicecollection","metadata":{"seo":{"title":"Retrieve invoices","description":"Retrieves a list of invoices."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetInvoiceCollection","name":"Retrieve invoices","isWebhook":false,"pointer":"/paths/~1invoices/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve invoices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of invoices."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."},{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1invoices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"q","in":"query","schemaId":"schema_782"},{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/invoices","href":"invoices/getinvoicecollection","openApiOperationId":"GetInvoiceCollection","summary":"Retrieve invoices","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$invoices = $client->invoices()->search([\n 'filter' => 'customerId:testCustomerId',\n]);\n"},{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.invoices.getAll();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100, sort: '-createdTime'};\nconst secondCollection = await api.invoices.getAll(params);\n\n// access the collection items, each item is an Invoice\nsecondCollection.items.forEach(invoice => console.log(invoice.fields.firstName));\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$invoicesPaginator = $service->invoices()->getAllPaginator(filter: 'customerId:testCustomerId', limit: 5);\nforeach ($invoicesPaginator as $invoicePage) {\n printf(\"Invoices page %d/%d\\n\", $invoicesPaginator->key() + 1, $invoicesPaginator->count());\n foreach ($invoicePage as $invoice) {\n printf(\"Invoice #%s (%s): %.2f\\n\", $invoice->getId(), $invoice->getStatus(), $invoice->getAmount());\n }\n}\n\n// OR\n\n$invoices = $service->invoices()->getAll(filter: 'customerId:testCustomerId', limit: 100);\nforeach ($invoices as $invoice) {\n printf(\"Invoice #%s (%s): %.2f\\n\", $invoice->getId(), $invoice->getStatus(), $invoice->getAmount());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of invoices retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_861"}},"schemaId":"schema_861","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1invoices/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_861","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_861"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getinvoicecollection"}],"panels":[]}]},"httpPath":"/invoices"},{"label":"Create an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoice","routeSlug":"/docs/dev-docs/api/invoices/postinvoice","metadata":{"seo":{"title":"Create an invoice","description":"Creates an invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostInvoice","name":"Create an invoice","isWebhook":false,"pointer":"/paths/~1invoices/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an invoice."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","pointer":"/paths/~1invoices/post/requestBody","description":"Invoice resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Invoice"}},"responseCodes":["201","401","403","422","429"],"pointer":"/invoices","href":"invoices/postinvoice","openApiOperationId":"PostInvoice","summary":"Create an invoice","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$invoiceForm = new Rebilly\\Entities\\Invoice();\n$invoiceForm->setCustomerId('customerId');\n$invoiceForm->setWebsiteId('websiteId');\n$invoiceForm->setCurrency('USD');\n$invoiceForm->setBillingAddress([\n 'firstName' => 'John',\n 'lastName' => 'Doe',\n 'organization' => 'Test LTD',\n 'address' => 'Test street 5',\n 'address2' => 'Test house 5',\n 'city' => 'New York',\n 'region' => 'Long Island',\n 'country' => 'US',\n 'postalCode' => '123456',\n 'emails' => [\n [\n 'label' => 'main',\n 'value' => 'johndoe@testemail.com',\n 'primary' => true,\n ],\n [\n 'label' => 'secondary',\n 'value' => 'otheremail@testemail.com',\n ],\n ],\n 'phoneNumbers' => [\n [\n 'label' => 'work',\n 'value' => '+123456789',\n 'primary' => true,\n ],\n [\n 'label' => 'home',\n 'value' => '+9874654321',\n ],\n ],\n]);\n\ntry {\n $invoice = $client->invoices()->create($invoiceForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the properties for the new invoice\nconst data = {\n customerId: 'foobar-0001',\n websiteId: 'my-main-website',\n currency: 'USD',\n billingAddress: {\n firstName: 'Johnny',\n lastName: 'Brown',\n emails: [{\n label: 'main',\n value: 'johnny+test@grr.la',\n primary: true\n }],\n },\n deliveryAddress: {\n firstName: 'Johnny',\n lastName: 'Brown',\n emails: [{\n label: 'main',\n value: 'johnny+test@grr.la',\n primary: true\n }],\n },\n notes: `customer's first invoice`,\n};\n\n// the ID is optional\nconst firstInvoice = await api.invoices.create({data});\n\n// or you can provide one\nconst secondInvoice = await api.invoices.create({id: 'my-second-id', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$invoice = \\Rebilly\\Sdk\\Model\\Invoice::from()\n ->setCustomerId('customerId')\n ->setWebsiteId('websiteId')\n ->setCurrency('USD')\n ->setBillingAddress([\n 'firstName' => 'John',\n 'lastName' => 'Doe',\n 'organization' => 'Test LTD',\n 'address' => 'Test street 5',\n 'address2' => 'Test house 5',\n 'city' => 'New York',\n 'region' => 'Long Island',\n 'country' => 'US',\n 'postalCode' => '123456',\n 'emails' => [\n [\n 'label' => 'main',\n 'value' => 'johndoe@testemail.com',\n 'primary' => true,\n ],\n [\n 'label' => 'secondary',\n 'value' => 'otheremail@testemail.com',\n ],\n ],\n 'phoneNumbers' => [\n [\n 'label' => 'work',\n 'value' => '+123456789',\n 'primary' => true,\n ],\n [\n 'label' => 'home',\n 'value' => '+9874654321',\n ],\n ],\n ]);\n\ntry {\n $invoice = $service->invoices()->create($invoice);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Invoice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Invoice created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1invoices/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/postinvoice"}],"panels":[]}]},"httpPath":"/invoices"},{"label":"Retrieve an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/getinvoice","routeSlug":"/docs/dev-docs/api/invoices/getinvoice","metadata":{"seo":{"title":"Retrieve an invoice","description":"Retrieves an invoice with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetInvoice","name":"Retrieve an invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an invoice with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1invoices~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1invoices~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_816","description":"Type of response media."}],"pointer":"/paths/~1invoices~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[{"name":"Accept","in":"header","schemaId":"schema_816"}],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/invoices/{id}","href":"invoices/getinvoice","openApiOperationId":"GetInvoice","summary":"Retrieve an invoice","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$invoice = $client->invoices()->load('invoiceId');\n"},{"lang":"JavaScript","source":"const invoice = await api.invoices.get({id: 'foobar-001'});\nconsole.log(invoice.fields.primaryAddress.firstName);\n\n\n// alternatively, download as a PDF file\nconst pdf = await api.invoices.downloadPDF({id: 'foobar-001'});\n// the invoice's data in arraybuffer format\nconsole.log(pdf.data);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$invoice = $service->invoices()->get('invoiceId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Invoice retrieved.","mediaType":"application/json","mediaTypes":["application/json","application/pdf"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"},"application/pdf":{"schemaId":"schema_817"}},"schemaId":"components/schemas/Invoice"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1invoices~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Invoice","mediaTypes":["application/json","application/pdf"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"},"application/pdf":{"schemaId":"schema_817"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getinvoice"}],"panels":[]}]},"httpPath":"/invoices/{id}"},{"label":"Upsert an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/putinvoice","routeSlug":"/docs/dev-docs/api/invoices/putinvoice","metadata":{"seo":{"title":"Upsert an invoice","description":"Creates or updates (upserts) an invoice with a specified ID. Returns a conflict error if the specified ID belongs to an upcoming invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutInvoice","name":"Upsert an invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates (upserts) an invoice with a specified ID.\nReturns a conflict error if the specified ID belongs to an upcoming invoice."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1invoices~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","pointer":"/paths/~1invoices~1{id}/put/requestBody","description":"Invoice resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/invoices/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Invoice"}},"responseCodes":["200","201","401","403","404","409","422","429"],"pointer":"/invoices/{id}","href":"invoices/putinvoice","openApiOperationId":"PutInvoice","summary":"Upsert an invoice","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$invoiceForm = new Rebilly\\Entities\\Invoice();\n$invoiceForm->setCustomerId('customerId');\n$invoiceForm->setWebsiteId('websiteId');\n$invoiceForm->setCurrency('USD');\n$invoiceForm->setBillingAddress([\n 'firstName' => 'John',\n 'lastName' => 'Doe',\n 'organization' => 'Test LTD',\n 'address' => 'Test street 5',\n 'address2' => 'Test house 5',\n 'city' => 'New York',\n 'region' => 'Long Island',\n 'country' => 'US',\n 'postalCode' => '123456',\n 'emails' => [\n [\n 'label' => 'main',\n 'value' => 'johndoe@testemail.com',\n 'primary' => true,\n ],\n [\n 'label' => 'secondary',\n 'value' => 'otheremail@testemail.com',\n ],\n ],\n 'phoneNumbers' => [\n [\n 'label' => 'work',\n 'value' => '+123456789',\n 'primary' => true,\n ],\n [\n 'label' => 'home',\n 'value' => '+9874654321',\n ],\n ],\n]);\n\ntry {\n $invoice = $client->invoices()->update('invoiceId', $invoiceForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// creating an invoice\nconst data = {\n customerId: 'foobar-0001',\n websiteId: 'my-main-website',\n currency: 'USD',\n billingAddress: {\n firstName: 'Johnny',\n lastName: 'Brown',\n emails: [{\n label: 'main',\n value: 'johnny+test@grr.la',\n primary: true\n }],\n },\n deliveryAddress: {\n firstName: 'Johnny',\n lastName: 'Brown',\n emails: [{\n label: 'main',\n value: 'johnny+test@grr.la',\n primary: true\n }],\n },\n notes: `customer's first invoice`,\n};\n\n// the ID is optional\nconst firstInvoice = await api.invoices.create({data});\n\n// or you can provide one\nconst secondInvoice = await api.invoices.create({id: 'my-second-id', data});\n\n\n\n// updating an invoice\nconst data = {\n customerId: 'foobar-0001',\n websiteId: 'my-main-website',\n currency: 'USD',\n billingAddress: {\n firstName: 'Johnny',\n lastName: 'Brown',\n emails: [{\n label: 'main',\n value: 'johnny+test@grr.la',\n primary: true\n }],\n },\n deliveryAddress: {\n firstName: 'Johnny',\n lastName: 'Brown',\n emails: [{\n label: 'main',\n value: 'johnny+test@grr.la',\n primary: true\n }],\n },\n notes: `customer's first invoice`,\n};\n\nconst invoice = await api.invoices.update({id: 'my-second-id', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$invoice = \\Rebilly\\Sdk\\Model\\Invoice::from()\n ->setCustomerId('customerId')\n ->setWebsiteId('websiteId')\n ->setCurrency('USD')\n ->setBillingAddress([\n 'firstName' => 'John',\n 'lastName' => 'Doe',\n 'organization' => 'Test LTD',\n 'address' => 'Test street 5',\n 'address2' => 'Test house 5',\n 'city' => 'New York',\n 'region' => 'Long Island',\n 'country' => 'US',\n 'postalCode' => '123456',\n 'emails' => [\n [\n 'label' => 'main',\n 'value' => 'johndoe@testemail.com',\n 'primary' => true,\n ],\n [\n 'label' => 'secondary',\n 'value' => 'otheremail@testemail.com',\n ],\n ],\n 'phoneNumbers' => [\n [\n 'label' => 'work',\n 'value' => '+123456789',\n 'primary' => true,\n ],\n [\n 'label' => 'home',\n 'value' => '+9874654321',\n ],\n ],\n ]);\n\ntry {\n $invoice = $service->invoices()->update('invoiceId', $invoice);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Invoice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Invoice updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Invoice created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1invoices~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"201","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/putinvoice"}],"panels":[]}]},"httpPath":"/invoices/{id}"},{"label":"Retrieve invoice items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/getinvoiceitemcollection","routeSlug":"/docs/dev-docs/api/invoices/getinvoiceitemcollection","metadata":{"seo":{"title":"Retrieve invoice items","description":"Retrieves invoice items with a specified invoice ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetInvoiceItemCollection","name":"Retrieve invoice items","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1items/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve invoice items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves invoice items with a specified invoice ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1invoices~1{id}~1items/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1invoices~1{id}~1items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{id}/items","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/invoices/{id}/items","href":"invoices/getinvoiceitemcollection","openApiOperationId":"GetInvoiceItemCollection","summary":"Retrieve invoice items","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$invoiceItems = $client->invoiceItems()->search('invoiceId', [\n 'filter' => 'quantity:5',\n]);\n"},{"lang":"JavaScript","source":"// get the top 20 invoice items for this ID\nconst invoiceItems = await api.invoices.getAllInvoiceItems({id: 'my-invoice-id', limit: 20});\ninvoiceItems.items.forEach(item => console.log(item.fields.description));"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$invoiceItems = $service->invoices()->getAllInvoiceItems('invoiceId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Invoice items retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_862"}},"schemaId":"schema_862"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1invoices~1{id}~1items/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_862","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_862"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getinvoiceitemcollection"}],"panels":[]}]},"httpPath":"/invoices/{id}/items"},{"label":"Create an invoice item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoiceitem","routeSlug":"/docs/dev-docs/api/invoices/postinvoiceitem","metadata":{"seo":{"title":"Create an invoice item","description":"Creates an invoice item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostInvoiceItem","name":"Create an invoice item","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1items/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an invoice item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an invoice item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1invoices~1{id}~1items/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceItem"}},"schemaId":"components/schemas/InvoiceItem","pointer":"/paths/~1invoices~1{id}~1items/post/requestBody","description":"InvoiceItem resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{id}/items","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceItem"}},"responseCodes":["201","401","422","429"],"pointer":"/invoices/{id}/items","href":"invoices/postinvoiceitem","openApiOperationId":"PostInvoiceItem","summary":"Create an invoice item","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$invoiceItemForm = new Rebilly\\Entities\\InvoiceItem();\n$invoiceItemForm->setType($invoiceItemForm::TYPE_DEBIT);\n$invoiceItemForm->setUnitPrice(0.99);\n$invoiceItemForm->setQuantity(5);\n\ntry {\n $invoiceItem = $client->invoiceItems()->create($invoiceItemForm, 'invoiceId');\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the properties for the new invoice item\nconst data = {\n type: 'debit', \n unitPrice: 5\n};\n\nconst invoiceItem = await api.invoices.createInvoiceItem({id: 'my-second-id', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$invoiceItem = new \\Rebilly\\Sdk\\Model\\InvoiceItem();\n$invoiceItemForm->setType(\\Rebilly\\Sdk\\Model\\InvoiceItem::TYPE_DEBIT);\n$invoiceItemForm->setUnitPrice(0.99);\n$invoiceItemForm->setQuantity(5);\n\ntry {\n $invoiceItem = $service->invoices()->createInvoiceItem('invoiceId', $invoiceItem);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/InvoiceItem","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceItem"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Invoice item created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceItem"}},"schemaId":"components/schemas/InvoiceItem","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1invoices~1{id}~1items/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/InvoiceItem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceItem"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/postinvoiceitem"}],"panels":[]}]},"httpPath":"/invoices/{id}/items"},{"label":"Retrieve an invoice item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/getinvoiceitem","routeSlug":"/docs/dev-docs/api/invoices/getinvoiceitem","metadata":{"seo":{"title":"Retrieve an invoice item","description":"Retrieves an invoice item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetInvoiceItem","name":"Retrieve an invoice item","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1items~1{itemId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an invoice item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an invoice item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"itemId","in":"path","schemaId":"schema_782","description":"ID of the invoice item.","required":true}],"pointer":"/paths/~1invoices~1{id}~1items~1{itemId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{id}/items/{itemId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"itemId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/invoices/{id}/items/{itemId}","href":"invoices/getinvoiceitem","openApiOperationId":"GetInvoiceItem","summary":"Retrieve an invoice item","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$invoiceItems = $client->invoiceItems()->load('invoiceId');\n"},{"lang":"JavaScript","source":"const invoiceItem = await api.invoices.getInvoiceItem({id: 'foobar-001'});\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$invoiceItem = $service->invoices()->getInvoiceItem('invoiceId', 'invoiceItemId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Invoice item retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceItem"}},"schemaId":"components/schemas/InvoiceItem"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1invoices~1{id}~1items~1{itemId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceItem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceItem"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getinvoiceitem"}],"panels":[]}]},"httpPath":"/invoices/{id}/items/{itemId}"},{"label":"Update an invoice item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/putinvoiceitem","routeSlug":"/docs/dev-docs/api/invoices/putinvoiceitem","metadata":{"seo":{"title":"Update an invoice item","description":"Updates an invoice item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutInvoiceItem","name":"Update an invoice item","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1items~1{itemId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an invoice item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an invoice item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"itemId","in":"path","schemaId":"schema_782","description":"ID of the invoice item.","required":true}],"pointer":"/paths/~1invoices~1{id}~1items~1{itemId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceItem"}},"schemaId":"components/schemas/InvoiceItem","pointer":"/paths/~1invoices~1{id}~1items~1{itemId}/put/requestBody","description":"Invoice item resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/invoices/{id}/items/{itemId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"itemId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceItem"}},"responseCodes":["200","401","422","429"],"pointer":"/invoices/{id}/items/{itemId}","href":"invoices/putinvoiceitem","openApiOperationId":"PutInvoiceItem","summary":"Update an invoice item","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$invoiceItemForm = new Rebilly\\Entities\\InvoiceItem();\n$invoiceItemForm->setType($invoiceItemForm::TYPE_DEBIT);\n$invoiceItemForm->setUnitPrice(0.99);\n$invoiceItemForm->setQuantity(5);\n\ntry {\n $invoiceItem = $client->invoiceItems()->update($invoiceItemForm, 'invoiceId', 'invoiceItemId');\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the properties for the new invoice item\nconst data = {\n type: 'debit',\n unitPrice: 5\n};\n\nconst invoiceItem = await api.invoices.updateInvoiceItem({id: 'id', itemId: 'itemId', data});\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$invoiceItem = \\Rebilly\\Sdk\\Model\\InvoiceItem::from([\n 'type' => \\Rebilly\\Sdk\\Model\\InvoiceItem::TYPE_DEBIT,\n 'unitPrice' => 0.99,\n 'quantity' => 5,\n]);\n\ntry {\n $invoiceItem = $service->invoices()->updateInvoiceItem('invoiceId', 'invoiceItemId', $invoiceItem);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/InvoiceItem","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceItem"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Invoice item updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceItem"}},"schemaId":"components/schemas/InvoiceItem","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1invoices~1{id}~1items~1{itemId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceItem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceItem"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/putinvoiceitem"}],"panels":[]}]},"httpPath":"/invoices/{id}/items/{itemId}"},{"label":"Delete an invoice item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/deleteinvoiceitem","routeSlug":"/docs/dev-docs/api/invoices/deleteinvoiceitem","metadata":{"seo":{"title":"Delete an invoice item","description":"Deletes an invoice item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteInvoiceItem","name":"Delete an invoice item","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1items~1{itemId}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an invoice item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an invoice item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"itemId","in":"path","schemaId":"schema_782","description":"ID of the invoice item.","required":true}],"pointer":"/paths/~1invoices~1{id}~1items~1{itemId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/invoices/{id}/items/{itemId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"itemId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","422","429"],"pointer":"/invoices/{id}/items/{itemId}","href":"invoices/deleteinvoiceitem","openApiOperationId":"DeleteInvoiceItem","summary":"Delete an invoice item","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$client->invoiceItems()->delete('invoiceId', 'invoiceItemId');\n"},{"lang":"JavaScript","source":"const invoiceItem = await api.invoices.deleteInvoiceItem({id: 'id', itemId: 'itemId'});\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$service->invoices()->deleteInvoiceItem('invoiceId', 'invoiceItemId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Invoice item deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1invoices~1{id}~1items~1{itemId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/deleteinvoiceitem"}],"panels":[]}]},"httpPath":"/invoices/{id}/items/{itemId}"},{"label":"Issue an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoiceissuance","routeSlug":"/docs/dev-docs/api/invoices/postinvoiceissuance","metadata":{"seo":{"title":"Issue an invoice","description":"Issues an invoice with a specified ID.The invoice must be in draft status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostInvoiceIssuance","name":"Issue an invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1issue/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issues an invoice with a specified ID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice must be in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1invoices~1{id}~1issue/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceIssue"}},"schemaId":"components/schemas/InvoiceIssue","pointer":"/paths/~1invoices~1{id}~1issue/post/requestBody","description":"Invoice issue resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{id}/issue","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceIssue"}},"responseCodes":["201","401","403","404","409","429"],"pointer":"/invoices/{id}/issue","href":"invoices/postinvoiceissuance","openApiOperationId":"PostInvoiceIssuance","summary":"Issue an invoice","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$invoice = $client->invoices()->issue('invoiceId', '2025-01-01 05:00:00');\n"},{"lang":"JavaScript","source":"// define the issued time\nconst data = {\n issuedTime: \"2017-09-19T20:46:51Z\"\n};\n\n// issue the invoice without an issued time\nconst firstInvoice = await api.invoices.issue({id: 'my-first-id'});\n\n// or include it\nconst secondInvoice = await api.invoices.issue({id: 'my-second-id', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$invoice = $service->invoices()->issue('invoiceId', new \\Rebilly\\Sdk\\Model\\InvoiceIssue([\n 'issuedTime' => '2025-01-01 05:00:00',\n]));"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/InvoiceIssue","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceIssue"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Invoice issued.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1invoices~1{id}~1issue/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/postinvoiceissuance"}],"panels":[]}]},"httpPath":"/invoices/{id}/issue"},{"label":"Abandon an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoiceabandonment","routeSlug":"/docs/dev-docs/api/invoices/postinvoiceabandonment","metadata":{"seo":{"title":"Abandon an invoice","description":"Abandons an invoice with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostInvoiceAbandonment","name":"Abandon an invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1abandon/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Abandon an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Abandons an invoice with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1invoices~1{id}~1abandon/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{id}/abandon","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","401","403","404","429"],"pointer":"/invoices/{id}/abandon","href":"invoices/postinvoiceabandonment","openApiOperationId":"PostInvoiceAbandonment","summary":"Abandon an invoice","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$invoice = $client->invoices()->abandon('invoiceId');\n"},{"lang":"JavaScript","source":"const abandonedInvoice = await api.invoices.abandon({id: 'my-invoice-id'});\nconsole.log(abandonedInvoice.fields.status);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$invoice = $service->invoices()->abandon('invoiceId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Invoice abandoned.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1invoices~1{id}~1abandon/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/postinvoiceabandonment"}],"panels":[]}]},"httpPath":"/invoices/{id}/abandon"},{"label":"Void an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoicevoid","routeSlug":"/docs/dev-docs/api/invoices/postinvoicevoid","metadata":{"seo":{"title":"Void an invoice","description":"Voids an invoice with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostInvoiceVoid","name":"Void an invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1void/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Void an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Voids an invoice with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1invoices~1{id}~1void/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{id}/void","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","401","403","404","429"],"pointer":"/invoices/{id}/void","href":"invoices/postinvoicevoid","openApiOperationId":"PostInvoiceVoid","summary":"Void an invoice","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$invoice = $client->invoices()->void('invoiceId');\n"},{"lang":"JavaScript","source":"const voidedInvoice = await api.invoices.void({id: 'my-invoice-id'});\nconsole.log(voidedInvoice.fields.status);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$invoice = $service->invoices()->void('invoiceId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Invoice voided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1invoices~1{id}~1void/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/postinvoicevoid"}],"panels":[]}]},"httpPath":"/invoices/{id}/void"},{"label":"Recalculate an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoicerecalculation","routeSlug":"/docs/dev-docs/api/invoices/postinvoicerecalculation","metadata":{"seo":{"title":"Recalculate an invoice","description":"Recalculates shipping rates, taxes, and discounts on an invoice with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostInvoiceRecalculation","name":"Recalculate an invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1recalculate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recalculate an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Recalculates shipping rates, taxes, and discounts on an invoice with a specified ID.\n\nOne use case for this operation to apply a revoked coupon,\nor coupon that is redeemed by a customer after the invoice is issued."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1invoices~1{id}~1recalculate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{id}/recalculate","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","401","403","404","409","429"],"pointer":"/invoices/{id}/recalculate","href":"invoices/postinvoicerecalculation","openApiOperationId":"PostInvoiceRecalculation","summary":"Recalculate an invoice","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$invoice = $service->invoices()->recalculate('invoiceId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Invoice recalculated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1invoices~1{id}~1recalculate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/postinvoicerecalculation"}],"panels":[]}]},"httpPath":"/invoices/{id}/recalculate"},{"label":"Reissue an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoicereissuance","routeSlug":"/docs/dev-docs/api/invoices/postinvoicereissuance","metadata":{"seo":{"title":"Reissue an invoice","description":"Reissues an invoice with a specified ID.The status of the invoice must be unpaid, partially paid, past due or abandoned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostInvoiceReissuance","name":"Reissue an invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1reissue/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reissue an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reissues an invoice with a specified ID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the invoice must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unpaid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partially paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"past due"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"abandoned"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1invoices~1{id}~1reissue/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceReissue"}},"schemaId":"components/schemas/InvoiceReissue","pointer":"/paths/~1invoices~1{id}~1reissue/post/requestBody","description":"InvoiceReissue resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{id}/reissue","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceReissue"}},"responseCodes":["201","401","403","404","409","429"],"pointer":"/invoices/{id}/reissue","href":"invoices/postinvoicereissuance","openApiOperationId":"PostInvoiceReissuance","summary":"Reissue an invoice","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$invoiceReissue = new \\Rebilly\\Sdk\\Model\\InvoiceReissue([\n 'dueTime' => '2025-01-01 05:00:00',\n]);\n\ntry {\n $invoiceReissue = $service->invoices()->reissue('invoiceId', $invoiceReissue);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/InvoiceReissue","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceReissue"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Invoice reissued.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1invoices~1{id}~1reissue/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/postinvoicereissuance"}],"panels":[]}]},"httpPath":"/invoices/{id}/reissue"},{"label":"Retrieve transaction amounts allocations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/getinvoicetransactionallocationcollection","routeSlug":"/docs/dev-docs/api/invoices/getinvoicetransactionallocationcollection","metadata":{"seo":{"title":"Retrieve transaction amounts allocations","description":"Retrieves amounts from a transaction that are allocated as invoice payments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetInvoiceTransactionAllocationCollection","name":"Retrieve transaction amounts allocations","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1transaction-allocations/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve transaction amounts allocations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves amounts from a transaction that are allocated as invoice payments."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1invoices~1{id}~1transaction-allocations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."}],"pointer":"/paths/~1invoices~1{id}~1transaction-allocations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{id}/transaction-allocations","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/invoices/{id}/transaction-allocations","href":"invoices/getinvoicetransactionallocationcollection","openApiOperationId":"GetInvoiceTransactionAllocationCollection","summary":"Retrieve transaction amounts allocations","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$transactionAllocations = $service->invoices()->getAllTransactionAllocations('invoiceId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of allocations retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_863"}},"schemaId":"schema_863","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1invoices~1{id}~1transaction-allocations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_863","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_863"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getinvoicetransactionallocationcollection"}],"panels":[]}]},"httpPath":"/invoices/{id}/transaction-allocations"},{"label":"Allocate customer credit balance to an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoiceallocatecreditbalance","routeSlug":"/docs/dev-docs/api/invoices/postinvoiceallocatecreditbalance","metadata":{"seo":{"title":"Allocate customer credit balance to an invoice","description":"Allocates existing allocatable credit memos related to the invoice customer.Specific credit memos cannot be provided in the request and are selected automatically.Allocation can be capped with amount.Credit memos are applied automatically in the specified allocation order.If no order is specified, oldest-first is used."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostInvoiceAllocateCreditBalance","name":"Allocate customer credit balance to an invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1allocate-credit-balance/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Allocate customer credit balance to an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allocates existing allocatable credit memos related to the invoice customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific credit memos cannot be provided in the request and are selected automatically."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allocation can be capped with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit memos are applied automatically in the specified allocation order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no order is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oldest-first"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1invoices~1{id}~1allocate-credit-balance/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceCreditMemoAllocationRequest"}},"schemaId":"components/schemas/InvoiceCreditMemoAllocationRequest","pointer":"/paths/~1invoices~1{id}~1allocate-credit-balance/post/requestBody","description":"Invoice credit memo automatic allocation settings."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{id}/allocate-credit-balance","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceCreditMemoAllocationRequest"}},"responseCodes":["200","401","403","404","422","429"],"pointer":"/invoices/{id}/allocate-credit-balance","href":"invoices/postinvoiceallocatecreditbalance","openApiOperationId":"PostInvoiceAllocateCreditBalance","summary":"Allocate customer credit balance to an invoice","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/InvoiceCreditMemoAllocationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceCreditMemoAllocationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Credit memos allocated to invoice.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceCreditMemoAllocationResponse"}},"schemaId":"components/schemas/InvoiceCreditMemoAllocationResponse","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1invoices~1{id}~1allocate-credit-balance/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceCreditMemoAllocationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceCreditMemoAllocationResponse"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/postinvoiceallocatecreditbalance"}],"panels":[]}]},"httpPath":"/invoices/{id}/allocate-credit-balance"},{"label":"Apply a transaction to an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices/postinvoicetransaction","routeSlug":"/docs/dev-docs/api/invoices/postinvoicetransaction","metadata":{"seo":{"title":"Apply a transaction to an invoice","description":"Applies a transaction to an invoice.The invoice status must be unpaid, and the transaction must have a non-zero unused amount."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostInvoiceTransaction","name":"Apply a transaction to an invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1transaction/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply a transaction to an invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies a transaction to an invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice status must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unpaid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the transaction must have a non-zero unused amount."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1invoices~1{id}~1transaction/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceTransaction"}},"schemaId":"components/schemas/InvoiceTransaction","pointer":"/paths/~1invoices~1{id}~1transaction/post/requestBody","description":"Invoice transaction resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{id}/transaction","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceTransaction"}},"responseCodes":["200","401","403","404","422","429"],"pointer":"/invoices/{id}/transaction","href":"invoices/postinvoicetransaction","openApiOperationId":"PostInvoiceTransaction","summary":"Apply a transaction to an invoice","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const params = {\n id: 'my-invoice-id', \n transactionId: 'my-transaction-id',\n amount: 12,99 \n};\n\nconst invoice = await api.invoices.applyTransaction(params);\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$invoiceTransaction = new \\Rebilly\\Sdk\\Model\\InvoiceTransaction([\n 'transactionId' => 'transactionId',\n 'amount' => 149.99,\n]);\n\ntry {\n $invoiceTransaction = $service->invoices()->applyTransaction('invoiceId', $invoiceTransaction);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/InvoiceTransaction","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceTransaction"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction applied to invoice.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1invoices~1{id}~1transaction/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/postinvoicetransaction"}],"panels":[]}]},"httpPath":"/invoices/{id}/transaction"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Invoice tax calculation failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-tax-calculation-failed","routeSlug":"/docs/dev-docs/api/invoices/invoice-tax-calculation-failed","metadata":{"seo":{"title":"Invoice tax calculation failed","description":"Invoice tax calculation failed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invoice-tax-calculation-failed","name":"Invoice tax calculation failed","isWebhook":true,"pointer":"/paths/invoice-tax-calculation-failed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice tax calculation failed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_864"}},"schemaId":"schema_864","pointer":"/paths/invoice-tax-calculation-failed/post/requestBody","description":"Payload of invoice tax calculation-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"invoice-tax-calculation-failed","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_864"}},"responseCodes":["2xx"],"pointer":"invoice-tax-calculation-failed","href":"invoices/invoice-tax-calculation-failed","openApiOperationId":"invoice-tax-calculation-failed","summary":"Invoice tax calculation failed","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_864","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_864"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/invoice-tax-calculation-failed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoice-tax-calculation-failed"}],"panels":[]}]},"httpPath":"invoice-tax-calculation-failed"},{"label":"Invoice abandoned","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-abandoned","routeSlug":"/docs/dev-docs/api/invoices/invoice-abandoned","metadata":{"seo":{"title":"Invoice abandoned","description":"Invoice abandoned"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invoice-abandoned","name":"Invoice abandoned","isWebhook":true,"pointer":"/paths/invoice-abandoned/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice abandoned","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"schemaId":"schema_865","pointer":"/paths/invoice-abandoned/post/requestBody","description":"Payload of invoice-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"invoice-abandoned","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_865"}},"responseCodes":["2xx"],"pointer":"invoice-abandoned","href":"invoices/invoice-abandoned","openApiOperationId":"invoice-abandoned","summary":"Invoice abandoned","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_865","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/invoice-abandoned/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoice-abandoned"}],"panels":[]}]},"httpPath":"invoice-abandoned"},{"label":"Invoice created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-created","routeSlug":"/docs/dev-docs/api/invoices/invoice-created","metadata":{"seo":{"title":"Invoice created","description":"Invoice created"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invoice-created","name":"Invoice created","isWebhook":true,"pointer":"/paths/invoice-created/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice created","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"schemaId":"schema_865","pointer":"/paths/invoice-created/post/requestBody","description":"Payload of invoice-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"invoice-created","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_865"}},"responseCodes":["2xx"],"pointer":"invoice-created","href":"invoices/invoice-created","openApiOperationId":"invoice-created","summary":"Invoice created","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_865","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/invoice-created/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoice-created"}],"panels":[]}]},"httpPath":"invoice-created"},{"label":"Invoice issued","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-issued","routeSlug":"/docs/dev-docs/api/invoices/invoice-issued","metadata":{"seo":{"title":"Invoice issued","description":"Invoice issued"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invoice-issued","name":"Invoice issued","isWebhook":true,"pointer":"/paths/invoice-issued/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice issued","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"schemaId":"schema_865","pointer":"/paths/invoice-issued/post/requestBody","description":"Payload of invoice-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"invoice-issued","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_865"}},"responseCodes":["2xx"],"pointer":"invoice-issued","href":"invoices/invoice-issued","openApiOperationId":"invoice-issued","summary":"Invoice issued","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_865","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/invoice-issued/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoice-issued"}],"panels":[]}]},"httpPath":"invoice-issued"},{"label":"Invoice modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-modified","routeSlug":"/docs/dev-docs/api/invoices/invoice-modified","metadata":{"seo":{"title":"Invoice modified","description":"Invoice modified"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invoice-modified","name":"Invoice modified","isWebhook":true,"pointer":"/paths/invoice-modified/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice modified","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"schemaId":"schema_865","pointer":"/paths/invoice-modified/post/requestBody","description":"Payload of invoice-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"invoice-modified","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_865"}},"responseCodes":["2xx"],"pointer":"invoice-modified","href":"invoices/invoice-modified","openApiOperationId":"invoice-modified","summary":"Invoice modified","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_865","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/invoice-modified/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoice-modified"}],"panels":[]}]},"httpPath":"invoice-modified"},{"label":"Invoice paid","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-paid","routeSlug":"/docs/dev-docs/api/invoices/invoice-paid","metadata":{"seo":{"title":"Invoice paid","description":"Invoice paid"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invoice-paid","name":"Invoice paid","isWebhook":true,"pointer":"/paths/invoice-paid/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice paid","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"schemaId":"schema_865","pointer":"/paths/invoice-paid/post/requestBody","description":"Payload of invoice-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"invoice-paid","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_865"}},"responseCodes":["2xx"],"pointer":"invoice-paid","href":"invoices/invoice-paid","openApiOperationId":"invoice-paid","summary":"Invoice paid","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_865","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/invoice-paid/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoice-paid"}],"panels":[]}]},"httpPath":"invoice-paid"},{"label":"Invoice partially paid","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-partially-paid","routeSlug":"/docs/dev-docs/api/invoices/invoice-partially-paid","metadata":{"seo":{"title":"Invoice partially paid","description":"Invoice partially paid"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invoice-partially-paid","name":"Invoice partially paid","isWebhook":true,"pointer":"/paths/invoice-partially-paid/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice partially paid","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"schemaId":"schema_865","pointer":"/paths/invoice-partially-paid/post/requestBody","description":"Payload of invoice-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"invoice-partially-paid","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_865"}},"responseCodes":["2xx"],"pointer":"invoice-partially-paid","href":"invoices/invoice-partially-paid","openApiOperationId":"invoice-partially-paid","summary":"Invoice partially paid","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_865","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/invoice-partially-paid/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoice-partially-paid"}],"panels":[]}]},"httpPath":"invoice-partially-paid"},{"label":"Invoice refunded","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-refunded","routeSlug":"/docs/dev-docs/api/invoices/invoice-refunded","metadata":{"seo":{"title":"Invoice refunded","description":"Invoice refunded"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invoice-refunded","name":"Invoice refunded","isWebhook":true,"pointer":"/paths/invoice-refunded/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice refunded","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"schemaId":"schema_865","pointer":"/paths/invoice-refunded/post/requestBody","description":"Payload of invoice-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"invoice-refunded","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_865"}},"responseCodes":["2xx"],"pointer":"invoice-refunded","href":"invoices/invoice-refunded","openApiOperationId":"invoice-refunded","summary":"Invoice refunded","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_865","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/invoice-refunded/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoice-refunded"}],"panels":[]}]},"httpPath":"invoice-refunded"},{"label":"Invoice partially refunded","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-partially-refunded","routeSlug":"/docs/dev-docs/api/invoices/invoice-partially-refunded","metadata":{"seo":{"title":"Invoice partially refunded","description":"Invoice partially refunded"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invoice-partially-refunded","name":"Invoice partially refunded","isWebhook":true,"pointer":"/paths/invoice-partially-refunded/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice partially refunded","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"schemaId":"schema_865","pointer":"/paths/invoice-partially-refunded/post/requestBody","description":"Payload of invoice-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"invoice-partially-refunded","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_865"}},"responseCodes":["2xx"],"pointer":"invoice-partially-refunded","href":"invoices/invoice-partially-refunded","openApiOperationId":"invoice-partially-refunded","summary":"Invoice partially refunded","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_865","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/invoice-partially-refunded/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoice-partially-refunded"}],"panels":[]}]},"httpPath":"invoice-partially-refunded"},{"label":"Invoice past due","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-past-due","routeSlug":"/docs/dev-docs/api/invoices/invoice-past-due","metadata":{"seo":{"title":"Invoice past due","description":"Invoice past due"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invoice-past-due","name":"Invoice past due","isWebhook":true,"pointer":"/paths/invoice-past-due/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice past due","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"schemaId":"schema_865","pointer":"/paths/invoice-past-due/post/requestBody","description":"Payload of invoice-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"invoice-past-due","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_865"}},"responseCodes":["2xx"],"pointer":"invoice-past-due","href":"invoices/invoice-past-due","openApiOperationId":"invoice-past-due","summary":"Invoice past due","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_865","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/invoice-past-due/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoice-past-due"}],"panels":[]}]},"httpPath":"invoice-past-due"},{"label":"Invoice past due reminder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-past-due-reminder","routeSlug":"/docs/dev-docs/api/invoices/invoice-past-due-reminder","metadata":{"seo":{"title":"Invoice past due reminder","description":"Invoice past due reminder"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invoice-past-due-reminder","name":"Invoice past due reminder","isWebhook":true,"pointer":"/paths/invoice-past-due-reminder/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice past due reminder","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"schemaId":"schema_865","pointer":"/paths/invoice-past-due-reminder/post/requestBody","description":"Payload of invoice-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"invoice-past-due-reminder","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_865"}},"responseCodes":["2xx"],"pointer":"invoice-past-due-reminder","href":"invoices/invoice-past-due-reminder","openApiOperationId":"invoice-past-due-reminder","summary":"Invoice past due reminder","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_865","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/invoice-past-due-reminder/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoice-past-due-reminder"}],"panels":[]}]},"httpPath":"invoice-past-due-reminder"},{"label":"Invoice reissued","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-reissued","routeSlug":"/docs/dev-docs/api/invoices/invoice-reissued","metadata":{"seo":{"title":"Invoice reissued","description":"Invoice reissued"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invoice-reissued","name":"Invoice reissued","isWebhook":true,"pointer":"/paths/invoice-reissued/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice reissued","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"schemaId":"schema_865","pointer":"/paths/invoice-reissued/post/requestBody","description":"Payload of invoice-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"invoice-reissued","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_865"}},"responseCodes":["2xx"],"pointer":"invoice-reissued","href":"invoices/invoice-reissued","openApiOperationId":"invoice-reissued","summary":"Invoice reissued","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_865","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/invoice-reissued/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoice-reissued"}],"panels":[]}]},"httpPath":"invoice-reissued"},{"label":"Invoice voided","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/invoice-voided","routeSlug":"/docs/dev-docs/api/invoices/invoice-voided","metadata":{"seo":{"title":"Invoice voided","description":"Invoice voided"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invoice-voided","name":"Invoice voided","isWebhook":true,"pointer":"/paths/invoice-voided/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice voided","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"schemaId":"schema_865","pointer":"/paths/invoice-voided/post/requestBody","description":"Payload of invoice-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"invoice-voided","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_865"}},"responseCodes":["2xx"],"pointer":"invoice-voided","href":"invoices/invoice-voided","openApiOperationId":"invoice-voided","summary":"Invoice voided","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_865","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_865"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/invoice-voided/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoice-voided"}],"panels":[]}]},"httpPath":"invoice-voided"},{"label":"Renewal invoice payment canceled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/renewal-invoice-payment-canceled","routeSlug":"/docs/dev-docs/api/invoices/renewal-invoice-payment-canceled","metadata":{"seo":{"title":"Renewal invoice payment canceled","description":"Renewal invoice payment canceled"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"renewal-invoice-payment-canceled","name":"Renewal invoice payment canceled","isWebhook":true,"pointer":"/paths/renewal-invoice-payment-canceled/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Renewal invoice payment canceled","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_866"}},"schemaId":"schema_866","pointer":"/paths/renewal-invoice-payment-canceled/post/requestBody","description":"Payload of invoice and transaction-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"renewal-invoice-payment-canceled","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_866"}},"responseCodes":["2xx"],"pointer":"renewal-invoice-payment-canceled","href":"invoices/renewal-invoice-payment-canceled","openApiOperationId":"renewal-invoice-payment-canceled","summary":"Renewal invoice payment canceled","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_866","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_866"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/renewal-invoice-payment-canceled/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/renewal-invoice-payment-canceled"}],"panels":[]}]},"httpPath":"renewal-invoice-payment-canceled"},{"label":"Renewal invoice payment declined","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/invoices/renewal-invoice-payment-declined","routeSlug":"/docs/dev-docs/api/invoices/renewal-invoice-payment-declined","metadata":{"seo":{"title":"Renewal invoice payment declined","description":"Renewal invoice payment declined"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"renewal-invoice-payment-declined","name":"Renewal invoice payment declined","isWebhook":true,"pointer":"/paths/renewal-invoice-payment-declined/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Renewal invoice payment declined","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_866"}},"schemaId":"schema_866","pointer":"/paths/renewal-invoice-payment-declined/post/requestBody","description":"Payload of invoice and transaction-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"renewal-invoice-payment-declined","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_866"}},"responseCodes":["2xx"],"pointer":"renewal-invoice-payment-declined","href":"invoices/renewal-invoice-payment-declined","openApiOperationId":"renewal-invoice-payment-declined","summary":"Renewal invoice payment declined","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_866","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_866"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/renewal-invoice-payment-declined/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/renewal-invoice-payment-declined"}],"panels":[]}]},"httpPath":"renewal-invoice-payment-declined"}],"content":{"contentType":"group","meta":{"name":"Invoices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoices","showPageActions":true},{"nodeType":"markdoc","content":"Use invoices to bill for the goods or services that you provide.\nIf your invoice includes subscription items, it also includes the corresponding service periods and prices."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/invoices","summary":"Retrieve invoices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getinvoicecollection","deprecated":false},{"title":"/invoices","summary":"Create an invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/postinvoice","deprecated":false},{"title":"/invoices/{id}","summary":"Retrieve an invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getinvoice","deprecated":false},{"title":"/invoices/{id}","summary":"Upsert an invoice","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoices/putinvoice","deprecated":false},{"title":"/invoices/{id}/items","summary":"Retrieve invoice items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getinvoiceitemcollection","deprecated":false},{"title":"/invoices/{id}/items","summary":"Create an invoice item","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/postinvoiceitem","deprecated":false},{"title":"/invoices/{id}/items/{itemId}","summary":"Retrieve an invoice item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getinvoiceitem","deprecated":false},{"title":"/invoices/{id}/items/{itemId}","summary":"Update an invoice item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoices/putinvoiceitem","deprecated":false},{"title":"/invoices/{id}/items/{itemId}","summary":"Delete an invoice item","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/invoices/deleteinvoiceitem","deprecated":false},{"title":"/invoices/{id}/issue","summary":"Issue an invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/postinvoiceissuance","deprecated":false},{"title":"/invoices/{id}/abandon","summary":"Abandon an invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/postinvoiceabandonment","deprecated":false},{"title":"/invoices/{id}/void","summary":"Void an invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/postinvoicevoid","deprecated":false},{"title":"/invoices/{id}/recalculate","summary":"Recalculate an invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/postinvoicerecalculation","deprecated":false},{"title":"/invoices/{id}/reissue","summary":"Reissue an invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/postinvoicereissuance","deprecated":false},{"title":"/invoices/{id}/transaction-allocations","summary":"Retrieve transaction amounts allocations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getinvoicetransactionallocationcollection","deprecated":false},{"title":"/invoices/{id}/allocate-credit-balance","summary":"Allocate customer credit balance to an invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/postinvoiceallocatecreditbalance","deprecated":false},{"title":"/invoices/{id}/transaction","summary":"Apply a transaction to an invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/postinvoicetransaction","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"invoice-tax-calculation-failed","summary":"Invoice tax calculation failed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/invoice-tax-calculation-failed","deprecated":false},{"title":"invoice-abandoned","summary":"Invoice abandoned","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/invoice-abandoned","deprecated":false},{"title":"invoice-created","summary":"Invoice created","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/invoice-created","deprecated":false},{"title":"invoice-issued","summary":"Invoice issued","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/invoice-issued","deprecated":false},{"title":"invoice-modified","summary":"Invoice modified","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/invoice-modified","deprecated":false},{"title":"invoice-paid","summary":"Invoice paid","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/invoice-paid","deprecated":false},{"title":"invoice-partially-paid","summary":"Invoice partially paid","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/invoice-partially-paid","deprecated":false},{"title":"invoice-refunded","summary":"Invoice refunded","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/invoice-refunded","deprecated":false},{"title":"invoice-partially-refunded","summary":"Invoice partially refunded","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/invoice-partially-refunded","deprecated":false},{"title":"invoice-past-due","summary":"Invoice past due","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/invoice-past-due","deprecated":false},{"title":"invoice-past-due-reminder","summary":"Invoice past due reminder","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/invoice-past-due-reminder","deprecated":false},{"title":"invoice-reissued","summary":"Invoice reissued","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/invoice-reissued","deprecated":false},{"title":"invoice-voided","summary":"Invoice voided","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/invoice-voided","deprecated":false},{"title":"renewal-invoice-payment-canceled","summary":"Renewal invoice payment canceled","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/renewal-invoice-payment-canceled","deprecated":false},{"title":"renewal-invoice-payment-declined","summary":"Renewal invoice payment declined","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/renewal-invoice-payment-declined","deprecated":false}]}]}]}]}},{"type":"group","label":"Usage","link":"/docs/dev-docs/api/usage","routeSlug":"/docs/dev-docs/api/usage","items":[{"label":"Retrieve usage records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/usage/getusagecollection","routeSlug":"/docs/dev-docs/api/usage/getusagecollection","metadata":{"seo":{"title":"Retrieve usage records","description":"Retrieves a list of usage records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetUsageCollection","name":"Retrieve usage records","isWebhook":false,"pointer":"/paths/~1usages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve usage records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of usage records."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."}],"pointer":"/paths/~1usages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/usages","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"q","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/usages","href":"usage/getusagecollection","openApiOperationId":"GetUsageCollection","summary":"Retrieve usage records","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of usage records retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_867"}},"schemaId":"schema_867","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1usages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_867","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_867"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usage/getusagecollection"}],"panels":[]}]},"httpPath":"/usages"},{"label":"Create a usage record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/usage/postusage","routeSlug":"/docs/dev-docs/api/usage/postusage","metadata":{"seo":{"title":"Create a usage record","description":"Creates a usage report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostUsage","name":"Create a usage record","isWebhook":false,"pointer":"/paths/~1usages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a usage record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a usage report."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Usage"}},"schemaId":"components/schemas/Usage","pointer":"/paths/~1usages/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/usages","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Usage"}},"responseCodes":["201","401","403","409","422","429"],"pointer":"/usages","href":"usage/postusage","openApiOperationId":"PostUsage","summary":"Create a usage record","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Usage","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Usage"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Usage record created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Usage"}},"schemaId":"components/schemas/Usage","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1usages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Usage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Usage"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usage/postusage"}],"panels":[]}]},"httpPath":"/usages"},{"label":"Retrieve a usage record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/usage/getusage","routeSlug":"/docs/dev-docs/api/usage/getusage","metadata":{"seo":{"title":"Retrieve a usage record","description":"Retrieves a usage record with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetUsage","name":"Retrieve a usage record","isWebhook":false,"pointer":"/paths/~1usages~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a usage record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a usage record with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1usages~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/usages/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/usages/{id}","href":"usage/getusage","openApiOperationId":"GetUsage","summary":"Retrieve a usage record","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Usage record retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Usage"}},"schemaId":"components/schemas/Usage"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1usages~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Usage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Usage"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usage/getusage"}],"panels":[]}]},"httpPath":"/usages/{id}"},{"label":"Delete a usage record","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/usage/deleteusage","routeSlug":"/docs/dev-docs/api/usage/deleteusage","metadata":{"seo":{"title":"Delete a usage record","description":"Deletes a usage record with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteUsage","name":"Delete a usage record","isWebhook":false,"pointer":"/paths/~1usages~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a usage record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a usage record with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1usages~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/usages/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","409","429"],"pointer":"/usages/{id}","href":"usage/deleteusage","openApiOperationId":"DeleteUsage","summary":"Delete a usage record","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Usage record deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1usages~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usage/deleteusage"}],"panels":[]}]},"httpPath":"/usages/{id}"}],"content":{"contentType":"group","meta":{"name":"Usage"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Usage","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these operations to manage the product usage of a subscription item for metered billing purposes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use metered billing when product quantity is unknown to the customer at the moment of creating a subscription."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metered billing is based on reported usage records."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every reported usage updates the quantity of an upcoming invoice item for a specified subscription and a plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a metered billing plan, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../Plans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/usages","summary":"Retrieve usage records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/usage/getusagecollection","deprecated":false},{"title":"/usages","summary":"Create a usage record","prefix":{"name":"post","color":"post"},"badges":[],"link":"/usage/postusage","deprecated":false},{"title":"/usages/{id}","summary":"Retrieve a usage record","prefix":{"name":"get","color":"get"},"badges":[],"link":"/usage/getusage","deprecated":false},{"title":"/usages/{id}","summary":"Delete a usage record","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/usage/deleteusage","deprecated":false}]}]}]}]}},{"type":"group","label":"Credit memos","link":"/docs/dev-docs/api/credit-memos","routeSlug":"/docs/dev-docs/api/credit-memos","items":[{"label":"Retrieve credit memos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos/getcreditmemocollection","routeSlug":"/docs/dev-docs/api/credit-memos/getcreditmemocollection","metadata":{"seo":{"title":"Retrieve credit memos","description":"Retrieves a list of credit memos."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCreditMemoCollection","name":"Retrieve credit memos","isWebhook":false,"pointer":"/paths/~1credit-memos/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve credit memos","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of credit memos."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."},{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1credit-memos/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credit-memos","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"q","in":"query","schemaId":"schema_782"},{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/credit-memos","href":"credit-memos/getcreditmemocollection","openApiOperationId":"GetCreditMemoCollection","summary":"Retrieve credit memos","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of credit memos retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_868"}},"schemaId":"schema_868","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1credit-memos/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_868","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_868"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/getcreditmemocollection"}],"panels":[]}]},"httpPath":"/credit-memos"},{"label":"Create a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos/postcreditmemo","routeSlug":"/docs/dev-docs/api/credit-memos/postcreditmemo","metadata":{"seo":{"title":"Create a credit memo","description":"Creates a credit memo."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostCreditMemo","name":"Create a credit memo","isWebhook":false,"pointer":"/paths/~1credit-memos/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a credit memo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a credit memo."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"schemaId":"components/schemas/CreditMemo","pointer":"/paths/~1credit-memos/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/credit-memos","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"responseCodes":["201","401","403","422","429"],"pointer":"/credit-memos","href":"credit-memos/postcreditmemo","openApiOperationId":"PostCreditMemo","summary":"Create a credit memo","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/CreditMemo","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Credit memo created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"schemaId":"components/schemas/CreditMemo","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1credit-memos/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreditMemo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/postcreditmemo"}],"panels":[]}]},"httpPath":"/credit-memos"},{"label":"Retrieve a credit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos/getcreditmemo","routeSlug":"/docs/dev-docs/api/credit-memos/getcreditmemo","metadata":{"seo":{"title":"Retrieve a credit memo","description":"Retrieves a credit memo with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCreditMemo","name":"Retrieve a credit memo","isWebhook":false,"pointer":"/paths/~1credit-memos~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a credit memo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a credit memo with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1credit-memos~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_816","description":"Type of response media."}],"pointer":"/paths/~1credit-memos~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credit-memos/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","schemaId":"schema_816"}],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/credit-memos/{id}","href":"credit-memos/getcreditmemo","openApiOperationId":"GetCreditMemo","summary":"Retrieve a credit memo","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Credit memo retrieved.","mediaType":"application/json","mediaTypes":["application/json","application/pdf"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"},"application/pdf":{"schemaId":"schema_817"}},"schemaId":"components/schemas/CreditMemo"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1credit-memos~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditMemo","mediaTypes":["application/json","application/pdf"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"},"application/pdf":{"schemaId":"schema_817"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/getcreditmemo"}],"panels":[]}]},"httpPath":"/credit-memos/{id}"},{"label":"Upsert a credit memo","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos/putcreditmemo","routeSlug":"/docs/dev-docs/api/credit-memos/putcreditmemo","metadata":{"seo":{"title":"Upsert a credit memo","description":"Creates or updates (upserts) a credit memo with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutCreditMemo","name":"Upsert a credit memo","isWebhook":false,"pointer":"/paths/~1credit-memos~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a credit memo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates (upserts) a credit memo with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1credit-memos~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"schemaId":"components/schemas/CreditMemo","pointer":"/paths/~1credit-memos~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/credit-memos/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"responseCodes":["200","201","401","403","404","422","429"],"pointer":"/credit-memos/{id}","href":"credit-memos/putcreditmemo","openApiOperationId":"PutCreditMemo","summary":"Upsert a credit memo","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/CreditMemo","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Credit memo updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"schemaId":"components/schemas/CreditMemo","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Credit memo created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"schemaId":"components/schemas/CreditMemo","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1credit-memos~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditMemo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}}},{"code":"201","schemaId":"components/schemas/CreditMemo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/putcreditmemo"}],"panels":[]}]},"httpPath":"/credit-memos/{id}"},{"label":"Partially update a credit memo","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos/patchcreditmemo","routeSlug":"/docs/dev-docs/api/credit-memos/patchcreditmemo","metadata":{"seo":{"title":"Partially update a credit memo","description":"Partially updates a credit memo with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PatchCreditMemo","name":"Partially update a credit memo","isWebhook":false,"pointer":"/paths/~1credit-memos~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update a credit memo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially updates a credit memo with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1credit-memos~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchCreditMemo"}},"schemaId":"components/schemas/PatchCreditMemo","pointer":"/paths/~1credit-memos~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/credit-memos/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchCreditMemo"}},"responseCodes":["200","401","403","404","422","429"],"pointer":"/credit-memos/{id}","href":"credit-memos/patchcreditmemo","openApiOperationId":"PatchCreditMemo","summary":"Partially update a credit memo","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/PatchCreditMemo","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchCreditMemo"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Credit memo updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"schemaId":"components/schemas/CreditMemo","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1credit-memos~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditMemo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/patchcreditmemo"}],"panels":[]}]},"httpPath":"/credit-memos/{id}"},{"label":"Void a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos/postcreditmemovoid","routeSlug":"/docs/dev-docs/api/credit-memos/postcreditmemovoid","metadata":{"seo":{"title":"Void a credit memo","description":"Voids a credit memo with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostCreditMemoVoid","name":"Void a credit memo","isWebhook":false,"pointer":"/paths/~1credit-memos~1{id}~1void/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Void a credit memo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Voids a credit memo with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1credit-memos~1{id}~1void/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/credit-memos/{id}/void","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","401","403","404","429"],"pointer":"/credit-memos/{id}/void","href":"credit-memos/postcreditmemovoid","openApiOperationId":"PostCreditMemoVoid","summary":"Void a credit memo","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Credit memo voided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"schemaId":"components/schemas/CreditMemo","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1credit-memos~1{id}~1void/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreditMemo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/postcreditmemovoid"}],"panels":[]}]},"httpPath":"/credit-memos/{id}/void"},{"label":"Refund a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos/postcreditmemorefund","routeSlug":"/docs/dev-docs/api/credit-memos/postcreditmemorefund","metadata":{"seo":{"title":"Refund a credit memo","description":"Refunds a credit memo with a specified ID. The transactions of the last invoice for the order or the invoice directly related to the credit memo are refunded."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostCreditMemoRefund","name":"Refund a credit memo","isWebhook":false,"pointer":"/paths/~1credit-memos~1{id}~1refund/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refund a credit memo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Refunds a credit memo with a specified ID.\nThe transactions of the last invoice for the order or the invoice directly related to the credit memo are refunded."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1credit-memos~1{id}~1refund/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/credit-memos/{id}/refund","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","409","429"],"pointer":"/credit-memos/{id}/refund","href":"credit-memos/postcreditmemorefund","openApiOperationId":"PostCreditMemoRefund","summary":"Refund a credit memo","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Credit memo refunded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"schemaId":"components/schemas/CreditMemo","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1credit-memos~1{id}~1refund/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditMemo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/postcreditmemorefund"}],"panels":[]}]},"httpPath":"/credit-memos/{id}/refund"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Credit memo applied","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/credit-memos/credit-memo-applied","routeSlug":"/docs/dev-docs/api/credit-memos/credit-memo-applied","metadata":{"seo":{"title":"Credit memo applied","description":"Credit memo applied"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"credit-memo-applied","name":"Credit memo applied","isWebhook":true,"pointer":"/paths/credit-memo-applied/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit memo applied","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_869"}},"schemaId":"schema_869","pointer":"/paths/credit-memo-applied/post/requestBody","description":"Payload of credit memo-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"credit-memo-applied","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_869"}},"responseCodes":["2xx"],"pointer":"credit-memo-applied","href":"credit-memos/credit-memo-applied","openApiOperationId":"credit-memo-applied","summary":"Credit memo applied","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_869","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_869"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/credit-memo-applied/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/credit-memo-applied"}],"panels":[]}]},"httpPath":"credit-memo-applied"},{"label":"Credit memo created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/credit-memos/credit-memo-created","routeSlug":"/docs/dev-docs/api/credit-memos/credit-memo-created","metadata":{"seo":{"title":"Credit memo created","description":"Credit memo created"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"credit-memo-created","name":"Credit memo created","isWebhook":true,"pointer":"/paths/credit-memo-created/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit memo created","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_869"}},"schemaId":"schema_869","pointer":"/paths/credit-memo-created/post/requestBody","description":"Payload of credit memo-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"credit-memo-created","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_869"}},"responseCodes":["2xx"],"pointer":"credit-memo-created","href":"credit-memos/credit-memo-created","openApiOperationId":"credit-memo-created","summary":"Credit memo created","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_869","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_869"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/credit-memo-created/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/credit-memo-created"}],"panels":[]}]},"httpPath":"credit-memo-created"},{"label":"Credit memo modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/credit-memos/credit-memo-modified","routeSlug":"/docs/dev-docs/api/credit-memos/credit-memo-modified","metadata":{"seo":{"title":"Credit memo modified","description":"Credit memo modified"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"credit-memo-modified","name":"Credit memo modified","isWebhook":true,"pointer":"/paths/credit-memo-modified/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit memo modified","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_869"}},"schemaId":"schema_869","pointer":"/paths/credit-memo-modified/post/requestBody","description":"Payload of credit memo-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"credit-memo-modified","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_869"}},"responseCodes":["2xx"],"pointer":"credit-memo-modified","href":"credit-memos/credit-memo-modified","openApiOperationId":"credit-memo-modified","summary":"Credit memo modified","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_869","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_869"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/credit-memo-modified/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/credit-memo-modified"}],"panels":[]}]},"httpPath":"credit-memo-modified"},{"label":"Credit memo partially applied","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/credit-memos/credit-memo-partially-applied","routeSlug":"/docs/dev-docs/api/credit-memos/credit-memo-partially-applied","metadata":{"seo":{"title":"Credit memo partially applied","description":"Credit memo partially applied"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"credit-memo-partially-applied","name":"Credit memo partially applied","isWebhook":true,"pointer":"/paths/credit-memo-partially-applied/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit memo partially applied","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_869"}},"schemaId":"schema_869","pointer":"/paths/credit-memo-partially-applied/post/requestBody","description":"Payload of credit memo-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"credit-memo-partially-applied","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_869"}},"responseCodes":["2xx"],"pointer":"credit-memo-partially-applied","href":"credit-memos/credit-memo-partially-applied","openApiOperationId":"credit-memo-partially-applied","summary":"Credit memo partially applied","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_869","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_869"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/credit-memo-partially-applied/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/credit-memo-partially-applied"}],"panels":[]}]},"httpPath":"credit-memo-partially-applied"},{"label":"Credit memo voided","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/credit-memos/credit-memo-voided","routeSlug":"/docs/dev-docs/api/credit-memos/credit-memo-voided","metadata":{"seo":{"title":"Credit memo voided","description":"Credit memo voided"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"credit-memo-voided","name":"Credit memo voided","isWebhook":true,"pointer":"/paths/credit-memo-voided/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit memo voided","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_869"}},"schemaId":"schema_869","pointer":"/paths/credit-memo-voided/post/requestBody","description":"Payload of credit memo-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"credit-memo-voided","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_869"}},"responseCodes":["2xx"],"pointer":"credit-memo-voided","href":"credit-memos/credit-memo-voided","openApiOperationId":"credit-memo-voided","summary":"Credit memo voided","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_869","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_869"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/credit-memo-voided/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/credit-memo-voided"}],"panels":[]}]},"httpPath":"credit-memo-voided"}],"content":{"contentType":"group","meta":{"name":"Credit memos"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit memos","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use credit memos to provide a customer with store credit."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A common use case for using a credit memo is to provide a customer with store credit,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rather than a refund, if the customer pays more than they owe or returns a product."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For information on the credit memo resource, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/concepts/#resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/credit-memos","summary":"Retrieve credit memos","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos/getcreditmemocollection","deprecated":false},{"title":"/credit-memos","summary":"Create a credit memo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/postcreditmemo","deprecated":false},{"title":"/credit-memos/{id}","summary":"Retrieve a credit memo","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos/getcreditmemo","deprecated":false},{"title":"/credit-memos/{id}","summary":"Upsert a credit memo","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credit-memos/putcreditmemo","deprecated":false},{"title":"/credit-memos/{id}","summary":"Partially update a credit memo","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/credit-memos/patchcreditmemo","deprecated":false},{"title":"/credit-memos/{id}/void","summary":"Void a credit memo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/postcreditmemovoid","deprecated":false},{"title":"/credit-memos/{id}/refund","summary":"Refund a credit memo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/postcreditmemorefund","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"credit-memo-applied","summary":"Credit memo applied","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/credit-memo-applied","deprecated":false},{"title":"credit-memo-created","summary":"Credit memo created","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/credit-memo-created","deprecated":false},{"title":"credit-memo-modified","summary":"Credit memo modified","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/credit-memo-modified","deprecated":false},{"title":"credit-memo-partially-applied","summary":"Credit memo partially applied","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/credit-memo-partially-applied","deprecated":false},{"title":"credit-memo-voided","summary":"Credit memo voided","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/credit-memo-voided","deprecated":false}]}]}]}]}},{"type":"group","label":"Plans","link":"/docs/dev-docs/api/plans","routeSlug":"/docs/dev-docs/api/plans","items":[{"label":"Retrieve plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/plans/getplancollection","routeSlug":"/docs/dev-docs/api/plans/getplancollection","metadata":{"seo":{"title":"Retrieve plans","description":"Retrieves a list of plans."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPlanCollection","name":"Retrieve plans","isWebhook":false,"pointer":"/paths/~1plans/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of plans."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."}],"pointer":"/paths/~1plans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/plans","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"q","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/plans","href":"plans/getplancollection","openApiOperationId":"GetPlanCollection","summary":"Retrieve plans","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$plans = $client->plans()->search([\n 'filter' => 'name:TestPlan',\n]);\n"},{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.plans.getAll();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100, sort: '-createdTime'};\nconst secondCollection = await api.plans.getAll(params);\n\n// access the collection items, each item is a Plan\nsecondCollection.items.forEach(plan => console.log(plan.fields.name));\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$plansPaginator = $service->plans()->getAllPaginator(limit: 5);\n\nforeach ($plansPaginator as $planPage) {\n printf(\"Plans page %d/%d\\n\", $plansPaginator->key() + 1, $plansPaginator->count());\n foreach ($planPage as $plan) {\n printf(\"Plan #%s: %s\\n\", $plan->getId(), $plan->getProductId());\n }\n}\n\n// OR\n\n$plans = $service->plans()->getAll(limit: 100);\nforeach ($plans as $plan) {\n printf(\"Plan #%s: %s\\n\", $plan->getId(), $plan->getProductId());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of plans retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_870"}},"schemaId":"schema_870","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1plans/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_870","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_870"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plans/getplancollection"}],"panels":[]}]},"httpPath":"/plans"},{"label":"Create a plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/plans/postplan","routeSlug":"/docs/dev-docs/api/plans/postplan","metadata":{"seo":{"title":"Create a plan","description":"Creates a plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostPlan","name":"Create a plan","isWebhook":false,"pointer":"/paths/~1plans/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a plan."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Plan"}},"schemaId":"components/schemas/Plan","pointer":"/paths/~1plans/post/requestBody","description":"Plan resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/plans","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Plan"}},"responseCodes":["201","401","403","422","429"],"pointer":"/plans","href":"plans/postplan","openApiOperationId":"PostPlan","summary":"Create a plan","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$planForm = new Rebilly\\Entities\\Plan();\n$planForm->setName('TestPlan');\n$planForm->setCurrency('USD');\n$planForm->setTrialAmount(1);\n$planForm->setTrialPeriodUnit('day');\n$planForm->setTrialPeriodLength(1);\n$planForm->setProductId('test-product');\n\ntry {\n $plan = $client->plans()->create($planForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the properties for the new plan\nconst data = {\n name: 'My strongest plan',\n currency: 'USD',\n setupAmount: 12.99,\n // you could also include a trial if needed\n recurringPeriodUnit: 'month',\n recurringPeriodLength: 1,\n recurringAmount: 25.99\n};\n\n// the ID is optional\nconst firstPlan = await api.plans.create({data});\n\n// or you can provide one\nconst secondPlan = await api.plans.create({id: 'my-second-key', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$plan = \\Rebilly\\Sdk\\Model\\SubscriptionPlan::from([])\n ->setProductId('productId')\n ->setName('Test plan')\n ->setCurrency('USD')\n ->setPricing(new \\Rebilly\\Sdk\\Model\\PlanFormulaFlatRate(['price' => 9.99]))\n ->setRecurringInterval(\n \\Rebilly\\Sdk\\Model\\SubscriptionPlanRecurringInterval::from()\n ->setUnit(\\Rebilly\\Sdk\\Model\\SubscriptionPlanRecurringInterval::UNIT_MONTH)\n ->setLength(1),\n );\n\ntry {\n $plan = $service->plans()->create($plan);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Plan","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Plan"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Plan created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Plan"}},"schemaId":"components/schemas/Plan","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1plans/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Plan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Plan"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plans/postplan"}],"panels":[]}]},"httpPath":"/plans"},{"label":"Retrieve a plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/plans/getplan","routeSlug":"/docs/dev-docs/api/plans/getplan","metadata":{"seo":{"title":"Retrieve a plan","description":"Retrieves a plan with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPlan","name":"Retrieve a plan","isWebhook":false,"pointer":"/paths/~1plans~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a plan with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1plans~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/plans/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/plans/{id}","href":"plans/getplan","openApiOperationId":"GetPlan","summary":"Retrieve a plan","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$plan = $client->plans()->load('planId');\n"},{"lang":"JavaScript","source":"const plan = await api.plans.get({id: 'foobar-001'});\nconsole.log(plan.fields.name);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$plan = $service->plans()->get('planId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Plan retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Plan"}},"schemaId":"components/schemas/Plan"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1plans~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Plan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Plan"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plans/getplan"}],"panels":[]}]},"httpPath":"/plans/{id}"},{"label":"Upsert a plan","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/plans/putplan","routeSlug":"/docs/dev-docs/api/plans/putplan","metadata":{"seo":{"title":"Upsert a plan","description":"Creates or updates (upserts) a plan with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutPlan","name":"Upsert a plan","isWebhook":false,"pointer":"/paths/~1plans~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates (upserts) a plan with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1plans~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Plan"}},"schemaId":"components/schemas/Plan","pointer":"/paths/~1plans~1{id}/put/requestBody","description":"Plan resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/plans/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Plan"}},"responseCodes":["200","201","401","403","404","422","429"],"pointer":"/plans/{id}","href":"plans/putplan","openApiOperationId":"PutPlan","summary":"Upsert a plan","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$planForm = new Rebilly\\Entities\\Plan();\n$planForm->setName('TestPlan');\n$planForm->setCurrency('USD');\n$planForm->setTrialAmount(1);\n$planForm->setTrialPeriodUnit('day');\n$planForm->setTrialPeriodLength(1);\n\ntry {\n $plan = $client->plans()->update('planId', $planForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the properties for the new plan\nconst data = {\n name: 'My strongest plan',\n currency: 'USD',\n setupAmount: 12.99,\n // you could also include a trial if needed\n recurringPeriodUnit: 'month',\n recurringPeriodLength: 1,\n recurringAmount: 25.99\n};\n\n// the ID is optional\nconst firstPlan = await api.plans.create({data});\n\n// or you can provide one\nconst secondPlan = await api.plans.create({id: 'my-second-key', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$plan = new \\Rebilly\\Sdk\\Model\\SubscriptionPlan([\n 'recurringInterval' => [\n 'unit' => \\Rebilly\\Sdk\\Model\\SubscriptionPlanRecurringInterval::UNIT_WEEK,\n 'length' => 2,\n ],\n]);\n\ntry {\n $plan = $service->plans()->update('planId', $plan);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n\n// OR\n\n$plan = $service->plans()->get('planId');\n$plan->setRecurringInterval(new \\Rebilly\\Sdk\\Model\\SubscriptionPlanRecurringInterval([\n 'unit' => \\Rebilly\\Sdk\\Model\\SubscriptionPlanRecurringInterval::UNIT_WEEK,\n 'length' => 2,\n]));\n\ntry {\n $plan = $service->plans()->update('planId', $plan);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Plan","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Plan"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Plan updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Plan"}},"schemaId":"components/schemas/Plan","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Plan created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Plan"}},"schemaId":"components/schemas/Plan","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1plans~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Plan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Plan"}}},{"code":"201","schemaId":"components/schemas/Plan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Plan"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plans/putplan"}],"panels":[]}]},"httpPath":"/plans/{id}"},{"label":"Delete a plan","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/plans/deleteplan","routeSlug":"/docs/dev-docs/api/plans/deleteplan","metadata":{"seo":{"title":"Delete a plan","description":"Deletes a plan with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePlan","name":"Delete a plan","isWebhook":false,"pointer":"/paths/~1plans~1{id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a plan with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1plans~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/plans/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","404","409","429"],"pointer":"/plans/{id}","href":"plans/deleteplan","openApiOperationId":"DeletePlan","summary":"Delete a plan","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$client->plans()->delete('planId');\n"},{"lang":"JavaScript","source":"const request = await api.plans.delete({id: 'my-second-key'});\n\n// the request does not return any fields but\n// you can confirm the success using the status code\nconsole.log(request.response.status); // 204"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$service->plans()->delete('planId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Plan deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1plans~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plans/deleteplan"}],"panels":[]}]},"httpPath":"/plans/{id}"}],"content":{"contentType":"group","meta":{"name":"Plans"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Plans","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use pricing plans to describe how the customer must pay for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/api/products/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"products"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rebilly provides the following plan types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trial only: Use this plan to create and offer a free or discounted trial period for your product."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a free 2 week trial of an internet service."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the trial, the customer can choose to sign up for a paid subscription, or stop using the service."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring: Use this plan to create and offer a subscription for your product."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a monthly subscription to an internet service that is charged at 20 USD per month."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One time sale: Use this plan to create and offer a one-off sale for your products."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a one time purchase of two bags of coffee."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For information on the plans resource, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/concepts/#plans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For information on plan pricing, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/pricing-formulas/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricing formulas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/plans","summary":"Retrieve plans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/plans/getplancollection","deprecated":false},{"title":"/plans","summary":"Create a plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/plans/postplan","deprecated":false},{"title":"/plans/{id}","summary":"Retrieve a plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/plans/getplan","deprecated":false},{"title":"/plans/{id}","summary":"Upsert a plan","prefix":{"name":"put","color":"put"},"badges":[],"link":"/plans/putplan","deprecated":false},{"title":"/plans/{id}","summary":"Delete a plan","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/plans/deleteplan","deprecated":false}]}]}]}]}},{"type":"group","label":"Products","link":"/docs/dev-docs/api/products","routeSlug":"/docs/dev-docs/api/products","items":[{"label":"Retrieve products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/products/getproductcollection","routeSlug":"/docs/dev-docs/api/products/getproductcollection","metadata":{"seo":{"title":"Retrieve products","description":"Retrieves a list of products."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetProductCollection","name":"Retrieve products","isWebhook":false,"pointer":"/paths/~1products/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of products."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."}],"pointer":"/paths/~1products/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/products","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"q","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/products","href":"products/getproductcollection","openApiOperationId":"GetProductCollection","summary":"Retrieve products","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.products.getAll();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100, sort: '-createdTime'};\nconst secondCollection = await api.products.getAll(params);\n\n// access the collection items, each item is a Product\nsecondCollection.items.forEach(product => console.log(product.fields.name));\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$productsPaginator = $service->products()->getAllPaginator(limit: 5);\nforeach ($productsPaginator as $productPage) {\n printf(\"Products page %d/%d\\n\", $productsPaginator->key() + 1, $productsPaginator->count());\n foreach ($productPage as $product) {\n printf(\"Product #%s: %s\\n\", $product->getId(), $product->getName());\n }\n}\n\n// OR\n\n$products = $service->products()->getAll(limit: 100);\nforeach ($products as $product) {\n printf(\"Product #%s: %s\\n\", $product->getId(), $product->getName());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of products retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_871"}},"schemaId":"schema_871","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1products/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_871","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_871"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/getproductcollection"}],"panels":[]}]},"httpPath":"/products"},{"label":"Create a product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/products/postproduct","routeSlug":"/docs/dev-docs/api/products/postproduct","metadata":{"seo":{"title":"Create a product","description":"Creates a product."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostProduct","name":"Create a product","isWebhook":false,"pointer":"/paths/~1products/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a product."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Product"}},"schemaId":"components/schemas/Product","pointer":"/paths/~1products/post/requestBody","description":"Product resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Product"}},"responseCodes":["201","401","403","422","429"],"pointer":"/products","href":"products/postproduct","openApiOperationId":"PostProduct","summary":"Create a product","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// first set the properties for the new product\nconst data = {\n name: 'my first product',\n description: 'made to be of the highest quality',\n taxCategoryId: '',\n requiresShipping: true,\n accountingCode: '100',\n customFields: []\n};\n\n// the ID is optional\nconst firstProduct = await api.products.create({data});\n\n// or you can provide one\nconst secondProduct = await api.products.create({id: 'my-second-key', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$product = new \\Rebilly\\Sdk\\Model\\Product([\n 'name' => 'my first product',\n 'description' => 'made to be of the highest quality',\n 'taxCategoryId' => '',\n 'requiresShipping' => true,\n 'accountingCode' => '100',\n]);\n\ntry {\n $product = $service->products()->create($product);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Product","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Product"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Product created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Product"}},"schemaId":"components/schemas/Product","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1products/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Product","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Product"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/postproduct"}],"panels":[]}]},"httpPath":"/products"},{"label":"Retrieve a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/products/getproduct","routeSlug":"/docs/dev-docs/api/products/getproduct","metadata":{"seo":{"title":"Retrieve a product","description":"Retrieves a product with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetProduct","name":"Retrieve a product","isWebhook":false,"pointer":"/paths/~1products~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a product with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1products~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/products/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/products/{id}","href":"products/getproduct","openApiOperationId":"GetProduct","summary":"Retrieve a product","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const product = await api.products.get({id: 'foobar-001'});\nconsole.log(product.fields.name);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$product = $service->products()->get('productId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Product"}},"schemaId":"components/schemas/Product"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1products~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Product","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Product"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/getproduct"}],"panels":[]}]},"httpPath":"/products/{id}"},{"label":"Upsert a product","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/products/putproduct","routeSlug":"/docs/dev-docs/api/products/putproduct","metadata":{"seo":{"title":"Upsert a product","description":"Creates or updates (upserts) a product with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutProduct","name":"Upsert a product","isWebhook":false,"pointer":"/paths/~1products~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates (upserts) a product with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1products~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Product"}},"schemaId":"components/schemas/Product","pointer":"/paths/~1products~1{id}/put/requestBody","description":"Product resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/products/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Product"}},"responseCodes":["200","201","401","403","422","429"],"pointer":"/products/{id}","href":"products/putproduct","openApiOperationId":"PutProduct","summary":"Upsert a product","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// creating a new product\nconst data = {\n name: 'my first product',\n description: 'made to be of the highest quality',\n taxCategoryId: '',\n requiresShipping: true,\n accountingCode: '100',\n customFields: []\n};\n\n// the ID is optional\nconst firstProduct = await api.products.create({data});\n\n// or you can provide one\nconst secondProduct = await api.products.create({id: 'my-second-key', data});\n\n\n\n// updating a product\nconst data = {\n name: 'my first product',\n description: 'made to be of the highest quality',\n taxCategoryId: '20010',\n requiresShipping: false,\n accountingCode: '77',\n customFields: []\n};\n\nconst product = await api.products.update({id: 'my-second-key', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$product = new \\Rebilly\\Sdk\\Model\\Product([\n 'requiresShipping' => false,\n 'accountingCode' => '101',\n]);\n\ntry {\n $product = $service->products()->update('productId', $product);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n\n// OR\n\n$product = $service->products()->get('productId');\n$product->setRequiresShipping(false)\n ->setAccountingCode('101');\n\ntry {\n $product = $service->products()->update('productId', $product);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Product","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Product"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Product"}},"schemaId":"components/schemas/Product","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Product created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Product"}},"schemaId":"components/schemas/Product","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1products~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Product","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Product"}}},{"code":"201","schemaId":"components/schemas/Product","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Product"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/putproduct"}],"panels":[]}]},"httpPath":"/products/{id}"},{"label":"Delete a product","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/products/deleteproduct","routeSlug":"/docs/dev-docs/api/products/deleteproduct","metadata":{"seo":{"title":"Delete a product","description":"Deletes a product with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteProduct","name":"Delete a product","isWebhook":false,"pointer":"/paths/~1products~1{id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a product with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1products~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/products/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","429"],"pointer":"/products/{id}","href":"products/deleteproduct","openApiOperationId":"DeleteProduct","summary":"Delete a product","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const request = await api.products.delete({id: 'my-second-key'});\n\n// the request does not return any fields but\n// you can confirm the success using the status code\nconsole.log(request.response.status); // 204"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$service->products()->delete('productId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Product deleted."},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1products~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/deleteproduct"}],"panels":[]}]},"httpPath":"/products/{id}"}],"content":{"contentType":"group","meta":{"name":"Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use products to describe the goods and services that your business sells."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A product also describes sales items on invoices and receipts."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product pricing is defined in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/api/plans/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A product may have one or many plans."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For information on the product resource, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/concepts/#products"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/products","summary":"Retrieve products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/getproductcollection","deprecated":false},{"title":"/products","summary":"Create a product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products/postproduct","deprecated":false},{"title":"/products/{id}","summary":"Retrieve a product","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/getproduct","deprecated":false},{"title":"/products/{id}","summary":"Upsert a product","prefix":{"name":"put","color":"put"},"badges":[],"link":"/products/putproduct","deprecated":false},{"title":"/products/{id}","summary":"Delete a product","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/products/deleteproduct","deprecated":false}]}]}]}]}},{"type":"group","label":"Coupons","link":"/docs/dev-docs/api/coupons","routeSlug":"/docs/dev-docs/api/coupons","items":[{"type":"link","label":"Coupon restriction types","link":"/docs/dev-docs/api/coupons/coupon-restriction-types","routeSlug":"/docs/dev-docs/api/coupons/coupon-restriction-types","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Coupon restriction types"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"coupons/coupon-restriction-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coupon restriction types"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following coupon description types are available:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"restrict-to-countries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Restricts a coupon for use in specific countries."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discounts-per-redemption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Restricts the number of times that the coupon can be applied by one redemption."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, use this restriction to configure a coupon that can only be applied to the first subscription renewal of a particular product."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum-order-amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Sets a minimum order amount for a coupon application."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if the restriction amount is $20, the coupon is only applied to invoices with a total amount of $20 or more."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"restrict-to-invoices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Restricts a coupon to specific invoices."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"restrict-to-plans"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Restricts a coupon to specific pricing plans."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"restrict-to-subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Restricts a coupon to specific order subscriptions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"restrict-to-customer-tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Restricts a coupon to customers with specific tags."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"restrict-to-customers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Restricts a coupon to specific customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"restrict-to-exclusive-application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Restricts a coupon so that it cannot be used in combination with other coupons. If more than one coupon is active, a coupon with this restriction is only applied if it provides a larger discount than the other coupons combined. If a coupon with this restriction is applied, all other coupons are removed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"restrict-to-products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Restricts a coupon to specific products."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid-by-time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Specifies a date and time at which a coupon redemption expires if not paid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redemptions-per-customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Restricts the number of times that a coupon can be redeemed by one customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, use this restriction to limit the number of redemptions to one per customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total-redemptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Restricts the number of times a coupon can be redeemed by different customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"restrict-to-bxgy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Provides \"buy X get Y\" promotions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These promotions incentivize new customers to buy and also reward existing customers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This restriction type enables you to add discounted plans to an invoice when a certain quantity of other plans are purchased."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if a customer buys two or more books, they get one free bookmark."},"children":[]}]}]}]}]}],"panels":[]}]}},{"label":"Retrieve coupon redemptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/getcouponredemptioncollection","routeSlug":"/docs/dev-docs/api/coupons/getcouponredemptioncollection","metadata":{"seo":{"title":"Retrieve coupon redemptions","description":"Retrieves a list of coupon redemptions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCouponRedemptionCollection","name":"Retrieve coupon redemptions","isWebhook":false,"pointer":"/paths/~1coupons-redemptions/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve coupon redemptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of coupon redemptions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1coupons-redemptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/coupons-redemptions","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"q","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/coupons-redemptions","href":"coupons/getcouponredemptioncollection","openApiOperationId":"GetCouponRedemptionCollection","summary":"Retrieve coupon redemptions","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$couponRedemptions = $client->couponsRedemptions()->search([\n 'filter' => 'customerId:testCustomer',\n]);\n"},{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.coupons.getAllRedemptions();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100, sort: '-createdTime'};\nconst secondCollection = await api.coupons.getAllRedemptions(params);\n\n// access the collection items, each item is a CouponRedemption\nsecondCollection.items.forEach(redemption => console.log(redemption.fields.status));\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$couponRedemptionsPaginator = $service->coupons()->getAllRedemptionsPaginator(limit: 5, filter: 'customerId:testCustomer');\nforeach ($couponRedemptionsPaginator as $couponRedemptionsPage) {\n printf(\"Coupon redemptions page %d/%d\\n\", $couponRedemptionsPaginator->key() + 1, $couponRedemptionsPaginator->count());\n foreach ($couponRedemptionsPage as $couponRedemption) {\n printf(\"Coupon redemption #%s\\n\", $couponRedemption->getId());\n }\n}\n\n// OR\n\n$couponRedemptions = $service->coupons()->getAllRedemptions(filter: 'customerId:testCustomer');\nforeach ($couponRedemptions as $couponRedemption) {\n printf(\"Coupon redemption #%s\\n\", $couponRedemption->getId());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of coupon redemptions retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_872"}},"schemaId":"schema_872","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1coupons-redemptions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_872","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_872"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/getcouponredemptioncollection"}],"panels":[]}]},"httpPath":"/coupons-redemptions"},{"label":"Redeem a coupon","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/postcouponredemption","routeSlug":"/docs/dev-docs/api/coupons/postcouponredemption","metadata":{"seo":{"title":"Redeem a coupon","description":"Redeems a coupon."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostCouponRedemption","name":"Redeem a coupon","isWebhook":false,"pointer":"/paths/~1coupons-redemptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Redeem a coupon","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Redeems a coupon."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CouponRedemption"}},"schemaId":"components/schemas/CouponRedemption","pointer":"/paths/~1coupons-redemptions/post/requestBody","description":"Coupon resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/coupons-redemptions","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CouponRedemption"}},"responseCodes":["201","401","403","422","429"],"pointer":"/coupons-redemptions","href":"coupons/postcouponredemption","openApiOperationId":"PostCouponRedemption","summary":"Redeem a coupon","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$redemptionForm = new Rebilly\\Entities\\Coupons\\Redemption();\n$redemptionForm->setCustomerId('customerId');\n$redemptionForm->setCouponId('couponId');\n\n$restrictionData = [\n 'type' => Rebilly\\Entities\\Coupons\\Restriction::TYPE_DISCOUNTS_PER_REDEMPTION,\n 'quantity' => 2,\n];\n\n$restrictionForm = Rebilly\\Entities\\Coupons\\Restriction::createFromData($restrictionData);\n\n$redemptionForm->setAdditionalRestrictions([$restrictionForm]);\n\ntry {\n $couponRedemption = $client->couponsRedemptions()->redeem($redemptionForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// build the redemption data\nconst data = {\n couponId: 'my-best-coupon',\n customerId: 'foobar-001'\n};\n\nconst redemption = await api.coupons.redeem({data});\nconsole.log(redemption.fields.id);\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$redemptionForm = new \\Rebilly\\Sdk\\Model\\CouponRedemption();\n$redemptionForm->setCustomerId('customerId');\n$redemptionForm->setCouponId('couponId');\n\n$restrictionForm = new \\Rebilly\\Sdk\\Model\\CouponRestrictionDiscountPerRedemption();\n$restrictionForm->setQuantity(2);\n\n$redemptionForm->setAdditionalRestrictions([$restrictionForm]);\n\ntry {\n $couponRedemption = $service->coupons()->redeem($redemptionForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/CouponRedemption","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CouponRedemption"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Coupon redeemed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponRedemption"}},"schemaId":"components/schemas/CouponRedemption","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1coupons-redemptions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CouponRedemption","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponRedemption"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/postcouponredemption"}],"panels":[]}]},"httpPath":"/coupons-redemptions"},{"label":"Retrieve a coupon redemption","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/getcouponredemption","routeSlug":"/docs/dev-docs/api/coupons/getcouponredemption","metadata":{"seo":{"title":"Retrieve a coupon redemption","description":"Retrieves a coupon redemption with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCouponRedemption","name":"Retrieve a coupon redemption","isWebhook":false,"pointer":"/paths/~1coupons-redemptions~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a coupon redemption","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a coupon redemption with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1coupons-redemptions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/coupons-redemptions/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/coupons-redemptions/{id}","href":"coupons/getcouponredemption","openApiOperationId":"GetCouponRedemption","summary":"Retrieve a coupon redemption","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$couponRedemption = $client->couponsRedemptions()->load('redemptionId');\n"},{"lang":"JavaScript","source":"const redemption = await api.coupons.getRedemption({id: 'foobar-001'});\nconsole.log(redemption.fields.id);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$couponRedemption = $service->coupons()->getRedemption('redemptionId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Coupon redemption retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponRedemption"}},"schemaId":"components/schemas/CouponRedemption"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1coupons-redemptions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CouponRedemption","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponRedemption"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/getcouponredemption"}],"panels":[]}]},"httpPath":"/coupons-redemptions/{id}"},{"label":"Cancel a coupon redemption","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/postcouponredemptioncancellation","routeSlug":"/docs/dev-docs/api/coupons/postcouponredemptioncancellation","metadata":{"seo":{"title":"Cancel a coupon redemption","description":"Cancels a coupon redemption with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostCouponRedemptionCancellation","name":"Cancel a coupon redemption","isWebhook":false,"pointer":"/paths/~1coupons-redemptions~1{id}~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a coupon redemption","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels a coupon redemption with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1coupons-redemptions~1{id}~1cancel/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/coupons-redemptions/{id}/cancel","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","401","403","404","429"],"pointer":"/coupons-redemptions/{id}/cancel","href":"coupons/postcouponredemptioncancellation","openApiOperationId":"PostCouponRedemptionCancellation","summary":"Cancel a coupon redemption","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$client->couponsRedemptions()->cancel('id');\n"},{"lang":"JavaScript","source":"const cancellation = await api.coupons.cancelRedemption({id: 'foobar-001'});\n\n// the request does not return any fields but\n// you can confirm the success using the status code\nconsole.log(cancellation.response.status); // 201"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$service->coupons()->cancelRedemption('id');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Coupon redemption canceled.","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1coupons-redemptions~1{id}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/postcouponredemptioncancellation"}],"panels":[]}]},"httpPath":"/coupons-redemptions/{id}/cancel"},{"label":"Retrieve coupons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/getcouponcollection","routeSlug":"/docs/dev-docs/api/coupons/getcouponcollection","metadata":{"seo":{"title":"Retrieve coupons","description":"Retrieves a list of coupons."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCouponCollection","name":"Retrieve coupons","isWebhook":false,"pointer":"/paths/~1coupons/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve coupons","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of coupons."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1coupons/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/coupons","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"q","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/coupons","href":"coupons/getcouponcollection","openApiOperationId":"GetCouponCollection","summary":"Retrieve coupons","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$coupons = $client->coupons()->search([\n 'filter' => 'status:issued',\n]);\n"},{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.coupons.getAll();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100, sort: '-createdTime'};\nconst secondCollection = await api.coupons.getAll(params);\n\n// access the collection items, each item is a Coupon\nsecondCollection.items.forEach(coupon => console.log(coupon.fields.status));\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$couponsPaginator = $service->coupons()->getAllPaginator(limit: 5, filter: 'status:issued');\nforeach ($couponsPaginator as $couponsPage) {\n printf(\"Coupons page %d/%d\\n\", $couponsPaginator->key() + 1, $couponsPaginator->count());\n foreach ($couponsPage as $coupon) {\n printf(\"Coupon #%s (%s): %s\\n\", $coupon->getId(), $coupon->getStatus(), $coupon->getDescription());\n }\n}\n\n// OR\n\n$coupons = $service->coupons()->getAll(filter: 'status:issued');\nforeach ($coupons as $coupon) {\n printf(\"Coupon #%s (%s): %s\\n\", $coupon->getId(), $coupon->getStatus(), $coupon->getDescription());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of coupons retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_873"}},"schemaId":"schema_873","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1coupons/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_873","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_873"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/getcouponcollection"}],"panels":[]}]},"httpPath":"/coupons"},{"label":"Create a coupon","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/postcoupon","routeSlug":"/docs/dev-docs/api/coupons/postcoupon","metadata":{"seo":{"title":"Create a coupon","description":"Creates a coupon."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostCoupon","name":"Create a coupon","isWebhook":false,"pointer":"/paths/~1coupons/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a coupon","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a coupon."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","pointer":"/paths/~1coupons/post/requestBody","description":"Coupon resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/coupons","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Coupon"}},"responseCodes":["201","401","403","422","429"],"pointer":"/coupons","href":"coupons/postcoupon","openApiOperationId":"PostCoupon","summary":"Create a coupon","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$couponForm = new Rebilly\\Entities\\Coupons\\Coupon();\n\n$discountArray = [\n 'currency' => 'USD',\n 'amount' => 1.99,\n];\n\n$discountForm = new \\Rebilly\\Entities\\Coupons\\Discounts\\Fixed($discountArray);\n$couponForm->setDiscount($discountForm);\n// Coupon can be used right now\n$couponForm->setIssuedTime(date('c'));\n\n$restrictionArray = [\n 'quantity' => 2,\n];\n\n$restrictionForm = new Rebilly\\Entities\\Coupons\\Restrictions\\DiscountsPerRedemption($restrictionArray);\n\n$couponForm->setRestrictions([$restrictionForm]);\n\ntry {\n $coupon = $client->coupons()->create($couponForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the required properties for the new coupon\nconst data = {\n description: 'a new coupon',\n issuedTime: '2017-09-19T20:46:44Z',\n discount: {\n type: 'percent',\n value: 12\n },\n restrictions: [{\n type: 'discounts-per-redemption',\n quantity: 12\n }]\n};\n\n// the ID is optional\nconst firstKey = await api.coupons.create({data});\n\n// or you can provide one\nconst secondKey = await api.coupons.create({id: 'my-second-id', data});\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$couponForm = new \\Rebilly\\Sdk\\Model\\Coupon();\n\n$discountForm = new \\Rebilly\\Sdk\\Model\\DiscountFixed();\n$discountForm->setCurrency('USD');\n$discountForm->setAmount(1.99);\n\n$couponForm->setDiscount($discountForm);\n// Coupon can be used right now\n$couponForm->setIssuedTime(date('c'));\n\n$restrictionArray = [\n 'quantity' => 2,\n];\n\n$restrictionForm = new \\Rebilly\\Sdk\\Model\\CouponRestrictionDiscountPerRedemption($restrictionArray);\n\n$couponForm->setRestrictions([$restrictionForm]);\n\ntry {\n $coupon = $service->coupons()->create($couponForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Coupon"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Coupon created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1coupons/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/postcoupon"}],"panels":[]}]},"httpPath":"/coupons"},{"label":"Retrieve a coupon","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/getcoupon","routeSlug":"/docs/dev-docs/api/coupons/getcoupon","metadata":{"seo":{"title":"Retrieve a coupon","description":"Retrieves a coupon with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCoupon","name":"Retrieve a coupon","isWebhook":false,"pointer":"/paths/~1coupons~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a coupon","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a coupon with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1coupons~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/coupons/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/coupons/{id}","href":"coupons/getcoupon","openApiOperationId":"GetCoupon","summary":"Retrieve a coupon","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$coupon = $client->coupons()->load('couponId');\n"},{"lang":"JavaScript","source":"const coupon = await api.coupons.get({couponId: 'foobar-001'});\nconsole.log(coupon.fields.status);\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$coupon = $service->coupons()->get('couponId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Coupon retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1coupons~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/getcoupon"}],"panels":[]}]},"httpPath":"/coupons/{id}"},{"label":"Upsert a coupon","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/putcoupon","routeSlug":"/docs/dev-docs/api/coupons/putcoupon","metadata":{"seo":{"title":"Upsert a coupon","description":"Creates or updates (upserts) a coupon with a specified coupon ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutCoupon","name":"Upsert a coupon","isWebhook":false,"pointer":"/paths/~1coupons~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a coupon","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates (upserts) a coupon with a specified coupon ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApplicationJWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1coupons~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","pointer":"/paths/~1coupons~1{id}/put/requestBody","description":"Coupon resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/coupons/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Coupon"}},"responseCodes":["200","201","401","404","409","422","429"],"pointer":"/coupons/{id}","href":"coupons/putcoupon","openApiOperationId":"PutCoupon","summary":"Upsert a coupon","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"ApplicationJWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$couponForm = new Rebilly\\Entities\\Coupons\\Coupon([\n 'issuedTime' => '2022-01-01T00:00:00-04:00',\n]);\n\n$discountArray = [\n 'type' => Rebilly\\Entities\\Coupons\\Discount::TYPE_FIXED,\n 'currency' => 'USD',\n 'amount' => 1.99,\n];\n\n$discountForm = Rebilly\\Entities\\Coupons\\Discount::createFromData($discountArray);\n$couponForm->setDiscount($discountForm);\n\n$restrictionArray = [\n 'type' => Rebilly\\Entities\\Coupons\\Restriction::TYPE_DISCOUNTS_PER_REDEMPTION,\n 'quantity' => 2,\n];\n\n$restrictionForm = Rebilly\\Entities\\Coupons\\Restriction::createFromData($restrictionArray);\n\n$couponForm->setRestrictions([$restrictionForm]);\n\ntry {\n $coupon = $client->coupons()->create($couponForm, 'couponId');\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// creating a coupon\nconst data = {\n description: 'a new coupon',\n issuedTime: '2017-09-19T20:46:44Z',\n discount: {\n type: 'percent',\n value: 12\n },\n restrictions: [{\n type: 'discounts-per-redemption',\n quantity: 12\n }]\n};\n\n// the ID is optional\nconst firstKey = await api.coupons.create({data});\n\n// or you can provide one\nconst secondKey = await api.coupons.create({id: 'my-second-id', data});\n\n\n// updating a coupon\nconst data = {\n description: 'a small update'\n};\n\nconst coupon = await api.coupons.update({id: 'my-second-id', data});\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$couponForm = new \\Rebilly\\Sdk\\Model\\Coupon();\n$couponForm->setIssuedTime('2022-01-01T00:00:00-04:00');\n\n$discountForm = new \\Rebilly\\Sdk\\Model\\DiscountFixed();\n$discountForm->setCurrency('USD');\n$discountForm->setAmount(1.99);\n\n$couponForm->setDiscount($discountForm);\n\n$restrictionForm = new \\Rebilly\\Sdk\\Model\\CouponRestrictionDiscountPerRedemption();\n$restrictionForm->setQuantity(2);\n\n$couponForm->setRestrictions([$restrictionForm]);\n\ntry {\n $coupon = $service->coupons()->update('couponId', $couponForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Coupon"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Coupon updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Coupon created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1coupons~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}}},{"code":"201","schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/putcoupon"}],"panels":[]}]},"httpPath":"/coupons/{id}"},{"label":"Specify a coupon expiration time","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/coupons/postcouponexpiration","routeSlug":"/docs/dev-docs/api/coupons/postcouponexpiration","metadata":{"seo":{"title":"Specify a coupon expiration time","description":"Specifies the expiration time of a coupon with a specified ID.The expiredTime of a coupon must be greater than its issuedTime."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostCouponExpiration","name":"Specify a coupon expiration time","isWebhook":false,"pointer":"/paths/~1coupons~1{id}~1expiration/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Specify a coupon expiration time","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the expiration time of a coupon with a specified ID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiredTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a coupon must be greater than its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuedTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This operation cannot be performed on expired coupons."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1coupons~1{id}~1expiration/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CouponExpiration"}},"schemaId":"components/schemas/CouponExpiration","pointer":"/paths/~1coupons~1{id}~1expiration/post/requestBody","description":"Coupon resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/coupons/{id}/expiration","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CouponExpiration"}},"responseCodes":["201","401","403","404","409","422","429"],"pointer":"/coupons/{id}/expiration","href":"coupons/postcouponexpiration","openApiOperationId":"PostCouponExpiration","summary":"Specify a coupon expiration time","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const data = {\n expiredTime: \"2020-05-25T18:51:14Z\"\n}\n\nconst coupon = await api.coupons.setExpiration({id: 'my-second-id', data});\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/CouponExpiration","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CouponExpiration"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Coupon expiration set.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Coupon is expired and has been redeemed.\nUnable to reschedule the expiration.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1coupons~1{id}~1expiration/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/postcouponexpiration"}],"panels":[]}]},"httpPath":"/coupons/{id}/expiration"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Coupon application removed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/coupons/coupon-application-removed","routeSlug":"/docs/dev-docs/api/coupons/coupon-application-removed","metadata":{"seo":{"title":"Coupon application removed","description":"Coupon application removed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"coupon-application-removed","name":"Coupon application removed","isWebhook":true,"pointer":"/paths/coupon-application-removed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Coupon application removed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_874"}},"schemaId":"schema_874","pointer":"/paths/coupon-application-removed/post/requestBody","description":"Payload of coupon redemption-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"coupon-application-removed","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_874"}},"responseCodes":["2xx"],"pointer":"coupon-application-removed","href":"coupons/coupon-application-removed","openApiOperationId":"coupon-application-removed","summary":"Coupon application removed","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_874","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_874"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/coupon-application-removed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/coupon-application-removed"}],"panels":[]}]},"httpPath":"coupon-application-removed"},{"label":"Coupon applied","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/coupons/coupon-applied","routeSlug":"/docs/dev-docs/api/coupons/coupon-applied","metadata":{"seo":{"title":"Coupon applied","description":"Coupon applied"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"coupon-applied","name":"Coupon applied","isWebhook":true,"pointer":"/paths/coupon-applied/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Coupon applied","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_874"}},"schemaId":"schema_874","pointer":"/paths/coupon-applied/post/requestBody","description":"Payload of coupon redemption-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"coupon-applied","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_874"}},"responseCodes":["2xx"],"pointer":"coupon-applied","href":"coupons/coupon-applied","openApiOperationId":"coupon-applied","summary":"Coupon applied","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_874","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_874"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/coupon-applied/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/coupon-applied"}],"panels":[]}]},"httpPath":"coupon-applied"},{"label":"Coupon expiration modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/coupons/coupon-expiration-modified","routeSlug":"/docs/dev-docs/api/coupons/coupon-expiration-modified","metadata":{"seo":{"title":"Coupon expiration modified","description":"Coupon expiration modified"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"coupon-expiration-modified","name":"Coupon expiration modified","isWebhook":true,"pointer":"/paths/coupon-expiration-modified/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Coupon expiration modified","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_875"}},"schemaId":"schema_875","pointer":"/paths/coupon-expiration-modified/post/requestBody","description":"Payload of coupon-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"coupon-expiration-modified","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_875"}},"responseCodes":["2xx"],"pointer":"coupon-expiration-modified","href":"coupons/coupon-expiration-modified","openApiOperationId":"coupon-expiration-modified","summary":"Coupon expiration modified","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_875","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_875"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/coupon-expiration-modified/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/coupon-expiration-modified"}],"panels":[]}]},"httpPath":"coupon-expiration-modified"},{"label":"Coupon expired","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/coupons/coupon-expired","routeSlug":"/docs/dev-docs/api/coupons/coupon-expired","metadata":{"seo":{"title":"Coupon expired","description":"Coupon expired"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"coupon-expired","name":"Coupon expired","isWebhook":true,"pointer":"/paths/coupon-expired/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Coupon expired","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_875"}},"schemaId":"schema_875","pointer":"/paths/coupon-expired/post/requestBody","description":"Payload of coupon-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"coupon-expired","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_875"}},"responseCodes":["2xx"],"pointer":"coupon-expired","href":"coupons/coupon-expired","openApiOperationId":"coupon-expired","summary":"Coupon expired","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_875","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_875"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/coupon-expired/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/coupon-expired"}],"panels":[]}]},"httpPath":"coupon-expired"},{"label":"Coupon issued","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/coupons/coupon-issued","routeSlug":"/docs/dev-docs/api/coupons/coupon-issued","metadata":{"seo":{"title":"Coupon issued","description":"Coupon issued"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"coupon-issued","name":"Coupon issued","isWebhook":true,"pointer":"/paths/coupon-issued/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Coupon issued","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_875"}},"schemaId":"schema_875","pointer":"/paths/coupon-issued/post/requestBody","description":"Payload of coupon-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"coupon-issued","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_875"}},"responseCodes":["2xx"],"pointer":"coupon-issued","href":"coupons/coupon-issued","openApiOperationId":"coupon-issued","summary":"Coupon issued","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_875","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_875"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/coupon-issued/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/coupon-issued"}],"panels":[]}]},"httpPath":"coupon-issued"},{"label":"Coupon modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/coupons/coupon-modified","routeSlug":"/docs/dev-docs/api/coupons/coupon-modified","metadata":{"seo":{"title":"Coupon modified","description":"Coupon modified"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"coupon-modified","name":"Coupon modified","isWebhook":true,"pointer":"/paths/coupon-modified/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Coupon modified","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_875"}},"schemaId":"schema_875","pointer":"/paths/coupon-modified/post/requestBody","description":"Payload of coupon-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"coupon-modified","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_875"}},"responseCodes":["2xx"],"pointer":"coupon-modified","href":"coupons/coupon-modified","openApiOperationId":"coupon-modified","summary":"Coupon modified","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_875","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_875"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/coupon-modified/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/coupon-modified"}],"panels":[]}]},"httpPath":"coupon-modified"},{"label":"Coupon redeemed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/coupons/coupon-redeemed","routeSlug":"/docs/dev-docs/api/coupons/coupon-redeemed","metadata":{"seo":{"title":"Coupon redeemed","description":"Coupon redeemed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"coupon-redeemed","name":"Coupon redeemed","isWebhook":true,"pointer":"/paths/coupon-redeemed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Coupon redeemed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_874"}},"schemaId":"schema_874","pointer":"/paths/coupon-redeemed/post/requestBody","description":"Payload of coupon redemption-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"coupon-redeemed","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_874"}},"responseCodes":["2xx"],"pointer":"coupon-redeemed","href":"coupons/coupon-redeemed","openApiOperationId":"coupon-redeemed","summary":"Coupon redeemed","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_874","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_874"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/coupon-redeemed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/coupon-redeemed"}],"panels":[]}]},"httpPath":"coupon-redeemed"},{"label":"Coupon redemption canceled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/coupons/coupon-redemption-canceled","routeSlug":"/docs/dev-docs/api/coupons/coupon-redemption-canceled","metadata":{"seo":{"title":"Coupon redemption canceled","description":"Coupon redemption canceled"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"coupon-redemption-canceled","name":"Coupon redemption canceled","isWebhook":true,"pointer":"/paths/coupon-redemption-canceled/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Coupon redemption canceled","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_874"}},"schemaId":"schema_874","pointer":"/paths/coupon-redemption-canceled/post/requestBody","description":"Payload of coupon redemption-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"coupon-redemption-canceled","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_874"}},"responseCodes":["2xx"],"pointer":"coupon-redemption-canceled","href":"coupons/coupon-redemption-canceled","openApiOperationId":"coupon-redemption-canceled","summary":"Coupon redemption canceled","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_874","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_874"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/coupon-redemption-canceled/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/coupon-redemption-canceled"}],"panels":[]}]},"httpPath":"coupon-redemption-canceled"}],"content":{"contentType":"group","meta":{"name":"Coupons"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Coupons","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use coupons to reward customers, generate sales, or to test new pricing strategies."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coupons enable you to apply different types of discounts to invoices, subscriptions, and pricing plans."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Redeemed coupons are attached to a customer's account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the coupon restrictions, the redeemed coupons are then applied from the customer's account to subsequent invoices or subscriptions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Redeemed coupons can only be applied to invoices of the same currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once a coupon is redeemed it cannot be modified."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You may deactivate a coupon or create a new coupon, but you cannot reuse the same coupon code."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have a use case where you must reuse the same code, "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/contact/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact Rebilly"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/coupons-redemptions","summary":"Retrieve coupon redemptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coupons/getcouponredemptioncollection","deprecated":false},{"title":"/coupons-redemptions","summary":"Redeem a coupon","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupons/postcouponredemption","deprecated":false},{"title":"/coupons-redemptions/{id}","summary":"Retrieve a coupon redemption","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coupons/getcouponredemption","deprecated":false},{"title":"/coupons-redemptions/{id}/cancel","summary":"Cancel a coupon redemption","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupons/postcouponredemptioncancellation","deprecated":false},{"title":"/coupons","summary":"Retrieve coupons","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coupons/getcouponcollection","deprecated":false},{"title":"/coupons","summary":"Create a coupon","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupons/postcoupon","deprecated":false},{"title":"/coupons/{id}","summary":"Retrieve a coupon","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coupons/getcoupon","deprecated":false},{"title":"/coupons/{id}","summary":"Upsert a coupon","prefix":{"name":"put","color":"put"},"badges":[],"link":"/coupons/putcoupon","deprecated":false},{"title":"/coupons/{id}/expiration","summary":"Specify a coupon expiration time","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupons/postcouponexpiration","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"coupon-application-removed","summary":"Coupon application removed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupons/coupon-application-removed","deprecated":false},{"title":"coupon-applied","summary":"Coupon applied","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupons/coupon-applied","deprecated":false},{"title":"coupon-expiration-modified","summary":"Coupon expiration modified","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupons/coupon-expiration-modified","deprecated":false},{"title":"coupon-expired","summary":"Coupon expired","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupons/coupon-expired","deprecated":false},{"title":"coupon-issued","summary":"Coupon issued","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupons/coupon-issued","deprecated":false},{"title":"coupon-modified","summary":"Coupon modified","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupons/coupon-modified","deprecated":false},{"title":"coupon-redeemed","summary":"Coupon redeemed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupons/coupon-redeemed","deprecated":false},{"title":"coupon-redemption-canceled","summary":"Coupon redemption canceled","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupons/coupon-redemption-canceled","deprecated":false}]}]}]}]}},{"type":"group","label":"Quotes","link":"/docs/dev-docs/api/quotes","routeSlug":"/docs/dev-docs/api/quotes","items":[{"label":"Retrieve quotes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/getquotecollection","routeSlug":"/docs/dev-docs/api/quotes/getquotecollection","metadata":{"seo":{"title":"Retrieve quotes","description":"Retrieves a list of quotes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetQuoteCollection","name":"Retrieve quotes","isWebhook":false,"pointer":"/paths/~1quotes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve quotes","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of quotes."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1quotes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/quotes","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/quotes","href":"quotes/getquotecollection","openApiOperationId":"GetQuoteCollection","summary":"Retrieve quotes","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of quotes retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_876"}},"schemaId":"schema_876","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1quotes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_876","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_876"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/getquotecollection"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/quotes"},{"label":"Create a quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/postquote","routeSlug":"/docs/dev-docs/api/quotes/postquote","metadata":{"seo":{"title":"Create a quote","description":"Creates a quote."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostQuote","name":"Create a quote","isWebhook":false,"pointer":"/paths/~1quotes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a quote","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a quote."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Quote"}},"schemaId":"components/schemas/Quote","pointer":"/paths/~1quotes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/quotes","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Quote"}},"responseCodes":["201","401","403","409","422","429"],"pointer":"/quotes","href":"quotes/postquote","openApiOperationId":"PostQuote","summary":"Create a quote","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Quote","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Quote"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Quote created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}},"schemaId":"components/schemas/Quote","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1quotes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Quote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/postquote"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/quotes"},{"label":"Retrieve a quote","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/getquote","routeSlug":"/docs/dev-docs/api/quotes/getquote","metadata":{"seo":{"title":"Retrieve a quote","description":"Retrieves a quote with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetQuote","name":"Retrieve a quote","isWebhook":false,"pointer":"/paths/~1quotes~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a quote","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a quote with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1quotes~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1quotes~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_816","description":"Type of response media."}],"pointer":"/paths/~1quotes~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/quotes/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[{"name":"Accept","in":"header","schemaId":"schema_816"}],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/quotes/{id}","href":"quotes/getquote","openApiOperationId":"GetQuote","summary":"Retrieve a quote","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Quote retrieved.","mediaType":"application/json","mediaTypes":["application/json","application/pdf"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"},"application/pdf":{"schemaId":"schema_817"}},"schemaId":"components/schemas/Quote"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1quotes~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Quote","mediaTypes":["application/json","application/pdf"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"},"application/pdf":{"schemaId":"schema_817"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/getquote"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}"},{"label":"Upsert a quote","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/putquote","routeSlug":"/docs/dev-docs/api/quotes/putquote","metadata":{"seo":{"title":"Upsert a quote","description":"Creates or updates a quote with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutQuote","name":"Upsert a quote","isWebhook":false,"pointer":"/paths/~1quotes~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a quote","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates or updates a quote with a specified ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The update operation can only be used for quotes with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1quotes~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Quote"}},"schemaId":"components/schemas/Quote","pointer":"/paths/~1quotes~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/quotes/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Quote"}},"responseCodes":["200","201","401","403","404","409","422","429"],"pointer":"/quotes/{id}","href":"quotes/putquote","openApiOperationId":"PutQuote","summary":"Upsert a quote","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Quote","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Quote"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Quote updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}},"schemaId":"components/schemas/Quote","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Quote created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}},"schemaId":"components/schemas/Quote","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1quotes~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Quote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}}},{"code":"201","schemaId":"components/schemas/Quote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/putquote"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}"},{"label":"Partially update a quote","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/patchquote","routeSlug":"/docs/dev-docs/api/quotes/patchquote","metadata":{"seo":{"title":"Partially update a quote","description":"Partially updates a quote with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PatchQuote","name":"Partially update a quote","isWebhook":false,"pointer":"/paths/~1quotes~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update a quote","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partially updates a quote with a specified ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The update operation can only be used for quotes with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1quotes~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchQuote"}},"schemaId":"components/schemas/PatchQuote","pointer":"/paths/~1quotes~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/quotes/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchQuote"}},"responseCodes":["200","401","403","404","422","429"],"pointer":"/quotes/{id}","href":"quotes/patchquote","openApiOperationId":"PatchQuote","summary":"Partially update a quote","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/PatchQuote","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchQuote"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Quote updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}},"schemaId":"components/schemas/Quote","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1quotes~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Quote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/patchquote"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}"},{"label":"Accept a quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/postquoteacceptance","routeSlug":"/docs/dev-docs/api/quotes/postquoteacceptance","metadata":{"seo":{"title":"Accept a quote","description":"Accepts an issued quote with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostQuoteAcceptance","name":"Accept a quote","isWebhook":false,"pointer":"/paths/~1quotes~1{id}~1accept/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accept a quote","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Accepts an issued quote with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1quotes~1{id}~1accept/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/quotes/{id}/accept","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","409","429"],"pointer":"/quotes/{id}/accept","href":"quotes/postquoteacceptance","openApiOperationId":"PostQuoteAcceptance","summary":"Accept a quote","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Quote accepted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}},"schemaId":"components/schemas/Quote","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1quotes~1{id}~1accept/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Quote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/postquoteacceptance"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/accept"},{"label":"Cancel a quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/postquotecancellation","routeSlug":"/docs/dev-docs/api/quotes/postquotecancellation","metadata":{"seo":{"title":"Cancel a quote","description":"Cancels a draft or issued quote with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostQuoteCancellation","name":"Cancel a quote","isWebhook":false,"pointer":"/paths/~1quotes~1{id}~1cancel/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a quote","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels a draft or issued quote with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1quotes~1{id}~1cancel/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/quotes/{id}/cancel","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","409","429"],"pointer":"/quotes/{id}/cancel","href":"quotes/postquotecancellation","openApiOperationId":"PostQuoteCancellation","summary":"Cancel a quote","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Quote canceled.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}},"schemaId":"components/schemas/Quote","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1quotes~1{id}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Quote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/postquotecancellation"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/cancel"},{"label":"Issue a quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/postquoteissuance","routeSlug":"/docs/dev-docs/api/quotes/postquoteissuance","metadata":{"seo":{"title":"Issue a quote","description":"Issues a draft quote with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostQuoteIssuance","name":"Issue a quote","isWebhook":false,"pointer":"/paths/~1quotes~1{id}~1issue/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue a quote","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Issues a draft quote with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1quotes~1{id}~1issue/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/quotes/{id}/issue","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","409","429"],"pointer":"/quotes/{id}/issue","href":"quotes/postquoteissuance","openApiOperationId":"PostQuoteIssuance","summary":"Issue a quote","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Quote issued.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}},"schemaId":"components/schemas/Quote","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1quotes~1{id}~1issue/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Quote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/postquoteissuance"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/issue"},{"label":"Recall a quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/postquoterecall","routeSlug":"/docs/dev-docs/api/quotes/postquoterecall","metadata":{"seo":{"title":"Recall a quote","description":"Recalls an issued quote with a specified ID so that it can be edited.Recalled quotes are assigned the status of draft."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostQuoteRecall","name":"Recall a quote","isWebhook":false,"pointer":"/paths/~1quotes~1{id}~1recall/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recall a quote","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recalls an issued quote with a specified ID so that it can be edited."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recalled quotes are assigned the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1quotes~1{id}~1recall/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/quotes/{id}/recall","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","409","429"],"pointer":"/quotes/{id}/recall","href":"quotes/postquoterecall","openApiOperationId":"PostQuoteRecall","summary":"Recall a quote","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Quote recalled.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}},"schemaId":"components/schemas/Quote","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1quotes~1{id}~1recall/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Quote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/postquoterecall"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/recall"},{"label":"Reject a quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes/postquoterejection","routeSlug":"/docs/dev-docs/api/quotes/postquoterejection","metadata":{"seo":{"title":"Reject a quote","description":"Rejects an issued quote with specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostQuoteRejection","name":"Reject a quote","isWebhook":false,"pointer":"/paths/~1quotes~1{id}~1reject/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reject a quote","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Rejects an issued quote with specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1quotes~1{id}~1reject/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/quotes/{id}/reject","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","409","429"],"pointer":"/quotes/{id}/reject","href":"quotes/postquoterejection","openApiOperationId":"PostQuoteRejection","summary":"Reject a quote","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Quote rejected.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}},"schemaId":"components/schemas/Quote","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1quotes~1{id}~1reject/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Quote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/postquoterejection"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/reject"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Quote accepted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/quotes/quote-accepted","routeSlug":"/docs/dev-docs/api/quotes/quote-accepted","metadata":{"seo":{"title":"Quote accepted","description":"Quote accepted"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"quote-accepted","name":"Quote accepted","isWebhook":true,"pointer":"/paths/quote-accepted/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quote accepted","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_877"}},"schemaId":"schema_877","pointer":"/paths/quote-accepted/post/requestBody","description":"Payload of quote-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"quote-accepted","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_877"}},"responseCodes":["2xx"],"pointer":"quote-accepted","href":"quotes/quote-accepted","openApiOperationId":"quote-accepted","summary":"Quote accepted","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_877","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_877"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/quote-accepted/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/quote-accepted"}],"panels":[]}]},"httpPath":"quote-accepted"},{"label":"Quote canceled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/quotes/quote-canceled","routeSlug":"/docs/dev-docs/api/quotes/quote-canceled","metadata":{"seo":{"title":"Quote canceled","description":"Quote canceled"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"quote-canceled","name":"Quote canceled","isWebhook":true,"pointer":"/paths/quote-canceled/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quote canceled","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_877"}},"schemaId":"schema_877","pointer":"/paths/quote-canceled/post/requestBody","description":"Payload of quote-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"quote-canceled","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_877"}},"responseCodes":["2xx"],"pointer":"quote-canceled","href":"quotes/quote-canceled","openApiOperationId":"quote-canceled","summary":"Quote canceled","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_877","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_877"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/quote-canceled/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/quote-canceled"}],"panels":[]}]},"httpPath":"quote-canceled"},{"label":"Quote created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/quotes/quote-created","routeSlug":"/docs/dev-docs/api/quotes/quote-created","metadata":{"seo":{"title":"Quote created","description":"Quote created"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"quote-created","name":"Quote created","isWebhook":true,"pointer":"/paths/quote-created/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quote created","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_877"}},"schemaId":"schema_877","pointer":"/paths/quote-created/post/requestBody","description":"Payload of quote-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"quote-created","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_877"}},"responseCodes":["2xx"],"pointer":"quote-created","href":"quotes/quote-created","openApiOperationId":"quote-created","summary":"Quote created","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_877","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_877"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/quote-created/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/quote-created"}],"panels":[]}]},"httpPath":"quote-created"},{"label":"Quote expired","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/quotes/quote-expired","routeSlug":"/docs/dev-docs/api/quotes/quote-expired","metadata":{"seo":{"title":"Quote expired","description":"Quote expired"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"quote-expired","name":"Quote expired","isWebhook":true,"pointer":"/paths/quote-expired/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quote expired","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_877"}},"schemaId":"schema_877","pointer":"/paths/quote-expired/post/requestBody","description":"Payload of quote-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"quote-expired","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_877"}},"responseCodes":["2xx"],"pointer":"quote-expired","href":"quotes/quote-expired","openApiOperationId":"quote-expired","summary":"Quote expired","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_877","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_877"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/quote-expired/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/quote-expired"}],"panels":[]}]},"httpPath":"quote-expired"},{"label":"Quote issued","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/quotes/quote-issued","routeSlug":"/docs/dev-docs/api/quotes/quote-issued","metadata":{"seo":{"title":"Quote issued","description":"Quote issued"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"quote-issued","name":"Quote issued","isWebhook":true,"pointer":"/paths/quote-issued/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quote issued","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_877"}},"schemaId":"schema_877","pointer":"/paths/quote-issued/post/requestBody","description":"Payload of quote-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"quote-issued","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_877"}},"responseCodes":["2xx"],"pointer":"quote-issued","href":"quotes/quote-issued","openApiOperationId":"quote-issued","summary":"Quote issued","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_877","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_877"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/quote-issued/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/quote-issued"}],"panels":[]}]},"httpPath":"quote-issued"},{"label":"Quote recalled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/quotes/quote-recalled","routeSlug":"/docs/dev-docs/api/quotes/quote-recalled","metadata":{"seo":{"title":"Quote recalled","description":"Quote recalled"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"quote-recalled","name":"Quote recalled","isWebhook":true,"pointer":"/paths/quote-recalled/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quote recalled","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_877"}},"schemaId":"schema_877","pointer":"/paths/quote-recalled/post/requestBody","description":"Payload of quote-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"quote-recalled","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_877"}},"responseCodes":["2xx"],"pointer":"quote-recalled","href":"quotes/quote-recalled","openApiOperationId":"quote-recalled","summary":"Quote recalled","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_877","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_877"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/quote-recalled/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/quote-recalled"}],"panels":[]}]},"httpPath":"quote-recalled"},{"label":"Quote rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/quotes/quote-rejected","routeSlug":"/docs/dev-docs/api/quotes/quote-rejected","metadata":{"seo":{"title":"Quote rejected","description":"Quote rejected"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"quote-rejected","name":"Quote rejected","isWebhook":true,"pointer":"/paths/quote-rejected/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quote rejected","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_877"}},"schemaId":"schema_877","pointer":"/paths/quote-rejected/post/requestBody","description":"Payload of quote-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"quote-rejected","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_877"}},"responseCodes":["2xx"],"pointer":"quote-rejected","href":"quotes/quote-rejected","openApiOperationId":"quote-rejected","summary":"Quote rejected","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_877","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_877"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/quote-rejected/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/quote-rejected"}],"panels":[]}]},"httpPath":"quote-rejected"},{"label":"Quote updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/quotes/quote-updated","routeSlug":"/docs/dev-docs/api/quotes/quote-updated","metadata":{"seo":{"title":"Quote updated","description":"Quote updated"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"quote-updated","name":"Quote updated","isWebhook":true,"pointer":"/paths/quote-updated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quote updated","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_877"}},"schemaId":"schema_877","pointer":"/paths/quote-updated/post/requestBody","description":"Payload of quote-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"quote-updated","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_877"}},"responseCodes":["2xx"],"pointer":"quote-updated","href":"quotes/quote-updated","openApiOperationId":"quote-updated","summary":"Quote updated","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_877","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_877"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/quote-updated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/quote-updated"}],"panels":[]}]},"httpPath":"quote-updated"}],"content":{"contentType":"group","meta":{"name":"Quotes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quotes","showPageActions":true},{"nodeType":"markdoc","content":"Use quote operations to create and manage quotations.\nQuotations describe the cost of goods or services to potential customers before they commit to a purchase.\nA quote contains an initial invoice preview that can be accepted to become an order.\n\nA quote can contain subscription and one-time sale items.\nWhen a quote contains one or more subscription items, it is a subscription order quote."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/quotes","summary":"Retrieve quotes","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/quotes/getquotecollection","deprecated":false},{"title":"/quotes","summary":"Create a quote","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/quotes/postquote","deprecated":false},{"title":"/quotes/{id}","summary":"Retrieve a quote","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/quotes/getquote","deprecated":false},{"title":"/quotes/{id}","summary":"Upsert a quote","prefix":{"name":"put","color":"put"},"badges":[{"name":"Experimental"}],"link":"/quotes/putquote","deprecated":false},{"title":"/quotes/{id}","summary":"Partially update a quote","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Experimental"}],"link":"/quotes/patchquote","deprecated":false},{"title":"/quotes/{id}/accept","summary":"Accept a quote","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/quotes/postquoteacceptance","deprecated":false},{"title":"/quotes/{id}/cancel","summary":"Cancel a quote","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/quotes/postquotecancellation","deprecated":false},{"title":"/quotes/{id}/issue","summary":"Issue a quote","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/quotes/postquoteissuance","deprecated":false},{"title":"/quotes/{id}/recall","summary":"Recall a quote","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/quotes/postquoterecall","deprecated":false},{"title":"/quotes/{id}/reject","summary":"Reject a quote","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/quotes/postquoterejection","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"quote-accepted","summary":"Quote accepted","prefix":{"name":"post","color":"post"},"badges":[],"link":"/quotes/quote-accepted","deprecated":false},{"title":"quote-canceled","summary":"Quote canceled","prefix":{"name":"post","color":"post"},"badges":[],"link":"/quotes/quote-canceled","deprecated":false},{"title":"quote-created","summary":"Quote created","prefix":{"name":"post","color":"post"},"badges":[],"link":"/quotes/quote-created","deprecated":false},{"title":"quote-expired","summary":"Quote expired","prefix":{"name":"post","color":"post"},"badges":[],"link":"/quotes/quote-expired","deprecated":false},{"title":"quote-issued","summary":"Quote issued","prefix":{"name":"post","color":"post"},"badges":[],"link":"/quotes/quote-issued","deprecated":false},{"title":"quote-recalled","summary":"Quote recalled","prefix":{"name":"post","color":"post"},"badges":[],"link":"/quotes/quote-recalled","deprecated":false},{"title":"quote-rejected","summary":"Quote rejected","prefix":{"name":"post","color":"post"},"badges":[],"link":"/quotes/quote-rejected","deprecated":false},{"title":"quote-updated","summary":"Quote updated","prefix":{"name":"post","color":"post"},"badges":[],"link":"/quotes/quote-updated","deprecated":false}]}]}]}]}},{"type":"group","label":"Quotes timeline","link":"/docs/dev-docs/api/quotes-timeline","routeSlug":"/docs/dev-docs/api/quotes-timeline","items":[{"label":"Retrieve quote timeline messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes-timeline/getquotetimelinecollection","routeSlug":"/docs/dev-docs/api/quotes-timeline/getquotetimelinecollection","metadata":{"seo":{"title":"Retrieve quote timeline messages","description":"Retrieves quote timeline messages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetQuoteTimelineCollection","name":"Retrieve quote timeline messages","isWebhook":false,"pointer":"/paths/~1quotes~1{id}~1timeline/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve quote timeline messages","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves quote timeline messages."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1quotes~1{id}~1timeline/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."}],"pointer":"/paths/~1quotes~1{id}~1timeline/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/quotes/{id}/timeline","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"q","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/quotes/{id}/timeline","href":"quotes-timeline/getquotetimelinecollection","openApiOperationId":"GetQuoteTimelineCollection","summary":"Retrieve quote timeline messages","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of quote timeline messages retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_878"}},"schemaId":"schema_878","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1quotes~1{id}~1timeline/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_878","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_878"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes-timeline/getquotetimelinecollection"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/timeline"},{"label":"Create a quote timeline comment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes-timeline/postquotetimeline","routeSlug":"/docs/dev-docs/api/quotes-timeline/postquotetimeline","metadata":{"seo":{"title":"Create a quote timeline comment","description":"Creates a quote timeline comment or custom defined event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostQuoteTimeline","name":"Create a quote timeline comment","isWebhook":false,"pointer":"/paths/~1quotes~1{id}~1timeline/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a quote timeline comment","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a quote timeline comment or custom defined event."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1quotes~1{id}~1timeline/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QuoteTimeline"}},"schemaId":"components/schemas/QuoteTimeline","pointer":"/paths/~1quotes~1{id}~1timeline/post/requestBody","description":"Quote timeline resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/quotes/{id}/timeline","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/QuoteTimeline"}},"responseCodes":["201","401","403","422","429"],"pointer":"/quotes/{id}/timeline","href":"quotes-timeline/postquotetimeline","openApiOperationId":"PostQuoteTimeline","summary":"Create a quote timeline comment","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/QuoteTimeline","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QuoteTimeline"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Quote timeline comment or custom defined event created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteTimeline"}},"schemaId":"components/schemas/QuoteTimeline","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1quotes~1{id}~1timeline/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/QuoteTimeline","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteTimeline"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes-timeline/postquotetimeline"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/timeline"},{"label":"Retrieve a quote timeline message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes-timeline/getquotetimeline","routeSlug":"/docs/dev-docs/api/quotes-timeline/getquotetimeline","metadata":{"seo":{"title":"Retrieve a quote timeline message","description":"Retrieves a quote timeline message with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetQuoteTimeline","name":"Retrieve a quote timeline message","isWebhook":false,"pointer":"/paths/~1quotes~1{id}~1timeline~1{messageId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a quote timeline message","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a quote timeline message with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"messageId","in":"path","schemaId":"schema_782","description":"ID of the quote timeline message.","required":true}],"pointer":"/paths/~1quotes~1{id}~1timeline~1{messageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/quotes/{id}/timeline/{messageId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"messageId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/quotes/{id}/timeline/{messageId}","href":"quotes-timeline/getquotetimeline","openApiOperationId":"GetQuoteTimeline","summary":"Retrieve a quote timeline message","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Quote timeline message retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteTimeline"}},"schemaId":"components/schemas/QuoteTimeline"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1quotes~1{id}~1timeline~1{messageId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/QuoteTimeline","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteTimeline"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes-timeline/getquotetimeline"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/timeline/{messageId}"},{"label":"Delete a quote timeline message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/quotes-timeline/deletequotetimeline","routeSlug":"/docs/dev-docs/api/quotes-timeline/deletequotetimeline","metadata":{"seo":{"title":"Delete a quote timeline message","description":"Deletes a quote timeline message with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteQuoteTimeline","name":"Delete a quote timeline message","isWebhook":false,"pointer":"/paths/~1quotes~1{id}~1timeline~1{messageId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a quote timeline message","badges":[{"name":"Experimental"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a quote timeline message with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"messageId","in":"path","schemaId":"schema_782","description":"ID of the quote timeline message.","required":true}],"pointer":"/paths/~1quotes~1{id}~1timeline~1{messageId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/quotes/{id}/timeline/{messageId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"messageId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","409","429"],"pointer":"/quotes/{id}/timeline/{messageId}","href":"quotes-timeline/deletequotetimeline","openApiOperationId":"DeleteQuoteTimeline","summary":"Delete a quote timeline message","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Quote timeline message deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1quotes~1{id}~1timeline~1{messageId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes-timeline/deletequotetimeline"}],"panels":[]}]},"badges":[{"name":"Experimental"}],"httpPath":"/quotes/{id}/timeline/{messageId}"}],"content":{"contentType":"group","meta":{"name":"Quotes timeline"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quotes timeline","showPageActions":true},{"nodeType":"markdoc","content":"Use quote timelines to maintain an audit trail of changes and activity for each quote."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/quotes/{id}/timeline","summary":"Retrieve quote timeline messages","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/quotes-timeline/getquotetimelinecollection","deprecated":false},{"title":"/quotes/{id}/timeline","summary":"Create a quote timeline comment","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental"}],"link":"/quotes-timeline/postquotetimeline","deprecated":false},{"title":"/quotes/{id}/timeline/{messageId}","summary":"Retrieve a quote timeline message","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental"}],"link":"/quotes-timeline/getquotetimeline","deprecated":false},{"title":"/quotes/{id}/timeline/{messageId}","summary":"Delete a quote timeline message","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Experimental"}],"link":"/quotes-timeline/deletequotetimeline","deprecated":false}]}]}]}]}},{"type":"group","label":"Shipping rates","link":"/docs/dev-docs/api/shipping-rates","routeSlug":"/docs/dev-docs/api/shipping-rates","items":[{"label":"Retrieve shipping rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/shipping-rates/getshippingratecollection","routeSlug":"/docs/dev-docs/api/shipping-rates/getshippingratecollection","metadata":{"seo":{"title":"Retrieve shipping rates","description":"Retrieves a list of shipping rates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetShippingRateCollection","name":"Retrieve shipping rates","isWebhook":false,"pointer":"/paths/~1shipping-rates/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve shipping rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of shipping rates."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."}],"pointer":"/paths/~1shipping-rates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/shipping-rates","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"q","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/shipping-rates","href":"shipping-rates/getshippingratecollection","openApiOperationId":"GetShippingRateCollection","summary":"Retrieve shipping rates","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.shippingRates.getAll();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100, sort: '-createdTime'};\nconst secondCollection = await api.shippingRates.getAll(params);\n\n// access the collection items, each item is a ShippingRate\nsecondCollection.items.forEach(shippingRate => console.log(shippingRate.fields.name));\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of shipping rates retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_879"}},"schemaId":"schema_879","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1shipping-rates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_879","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_879"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-rates/getshippingratecollection"}],"panels":[]}]},"httpPath":"/shipping-rates"},{"label":"Create a shipping rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/shipping-rates/postshippingrate","routeSlug":"/docs/dev-docs/api/shipping-rates/postshippingrate","metadata":{"seo":{"title":"Create a shipping rate","description":"Creates a shipping rate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostShippingRate","name":"Create a shipping rate","isWebhook":false,"pointer":"/paths/~1shipping-rates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a shipping rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a shipping rate."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShippingRate"}},"schemaId":"components/schemas/ShippingRate","pointer":"/paths/~1shipping-rates/post/requestBody","description":"Shipping rate resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/shipping-rates","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShippingRate"}},"responseCodes":["201","401","403","422","429"],"pointer":"/shipping-rates","href":"shipping-rates/postshippingrate","openApiOperationId":"PostShippingRate","summary":"Create a shipping rate","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// first set the properties for the new shipping rate\nconst data = {\n name: 'free shipping',\n filter: '',\n price: 0,\n currency: 'USD'\n};\n\n// the ID is optional\nconst firstRate = await api.shippingRates.create({data});\n\n// or you can provide one\nconst secondRate = await api.shippingRates.create({id: 'my-second-key', data});\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/ShippingRate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShippingRate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Shipping rate created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingRate"}},"schemaId":"components/schemas/ShippingRate","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1shipping-rates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ShippingRate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingRate"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-rates/postshippingrate"}],"panels":[]}]},"httpPath":"/shipping-rates"},{"label":"Retrieve a shipping rate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/shipping-rates/getshippingrate","routeSlug":"/docs/dev-docs/api/shipping-rates/getshippingrate","metadata":{"seo":{"title":"Retrieve a shipping rate","description":"Retrieves a shipping rate with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetShippingRate","name":"Retrieve a shipping rate","isWebhook":false,"pointer":"/paths/~1shipping-rates~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a shipping rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a shipping rate with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1shipping-rates~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/shipping-rates/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/shipping-rates/{id}","href":"shipping-rates/getshippingrate","openApiOperationId":"GetShippingRate","summary":"Retrieve a shipping rate","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const shippingRate = await api.shippingRates.get({id: 'foobar-001'});\nconsole.log(shippingRate.fields.name);\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Shipping rate retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingRate"}},"schemaId":"components/schemas/ShippingRate"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1shipping-rates~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShippingRate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingRate"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-rates/getshippingrate"}],"panels":[]}]},"httpPath":"/shipping-rates/{id}"},{"label":"Create a shipping rate with ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/shipping-rates/putshippingrate","routeSlug":"/docs/dev-docs/api/shipping-rates/putshippingrate","metadata":{"seo":{"title":"Create a shipping rate with ID","description":"Creates a shipping rate with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutShippingRate","name":"Create a shipping rate with ID","isWebhook":false,"pointer":"/paths/~1shipping-rates~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a shipping rate with ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a shipping rate with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1shipping-rates~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShippingRate"}},"schemaId":"components/schemas/ShippingRate","pointer":"/paths/~1shipping-rates~1{id}/put/requestBody","description":"Shipping rate resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/shipping-rates/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShippingRate"}},"responseCodes":["200","201","401","403","422","429"],"pointer":"/shipping-rates/{id}","href":"shipping-rates/putshippingrate","openApiOperationId":"PutShippingRate","summary":"Create a shipping rate with ID","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// creating a new shipping rate\nconst data = {\n name: 'free shipping',\n filter: '',\n price: 0,\n currency: 'USD'\n};\n\n// the ID is optional\nconst firstRate = await api.shippingRates.create({data});\n\n// or you can provide one\nconst secondRate = await api.shippingRates.create({id: 'my-second-key', data});\n\n\n// updating a shipping rate\nconst data = {\n name: 'regular shipping',\n filter: '',\n price: 9.99,\n currency: 'USD'\n};\n\nconst shippingRate = await api.shippingRates.update({id: 'my-second-key', data});\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/ShippingRate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShippingRate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Shipping rate updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingRate"}},"schemaId":"components/schemas/ShippingRate","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Shipping rate created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingRate"}},"schemaId":"components/schemas/ShippingRate","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1shipping-rates~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShippingRate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingRate"}}},{"code":"201","schemaId":"components/schemas/ShippingRate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingRate"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-rates/putshippingrate"}],"panels":[]}]},"httpPath":"/shipping-rates/{id}"},{"label":"Delete a shipping rate","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/shipping-rates/deleteshippingrate","routeSlug":"/docs/dev-docs/api/shipping-rates/deleteshippingrate","metadata":{"seo":{"title":"Delete a shipping rate","description":"Deletes a shipping rate with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteShippingRate","name":"Delete a shipping rate","isWebhook":false,"pointer":"/paths/~1shipping-rates~1{id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a shipping rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a shipping rate with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1shipping-rates~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/shipping-rates/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","409","429"],"pointer":"/shipping-rates/{id}","href":"shipping-rates/deleteshippingrate","openApiOperationId":"DeleteShippingRate","summary":"Delete a shipping rate","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const request = await api.shippingRates.delete({id: 'my-second-key'});\n\n// the request does not return any fields but\n// you can confirm the success using the status code\nconsole.log(request.response.status); // 204\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Shipping rate deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1shipping-rates~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-rates/deleteshippingrate"}],"panels":[]}]},"httpPath":"/shipping-rates/{id}"}],"content":{"contentType":"group","meta":{"name":"Shipping rates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipping rates","showPageActions":true},{"nodeType":"markdoc","content":"Use these operations to manage shipping rates.\nA shipping rate contains a filter and a pricing for a specific shipping destination."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/shipping-rates","summary":"Retrieve shipping rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipping-rates/getshippingratecollection","deprecated":false},{"title":"/shipping-rates","summary":"Create a shipping rate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipping-rates/postshippingrate","deprecated":false},{"title":"/shipping-rates/{id}","summary":"Retrieve a shipping rate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipping-rates/getshippingrate","deprecated":false},{"title":"/shipping-rates/{id}","summary":"Create a shipping rate with ID","prefix":{"name":"put","color":"put"},"badges":[],"link":"/shipping-rates/putshippingrate","deprecated":false},{"title":"/shipping-rates/{id}","summary":"Delete a shipping rate","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/shipping-rates/deleteshippingrate","deprecated":false}]}]}]}]}},{"type":"group","label":"Orders timeline","link":"/docs/dev-docs/api/orders-timeline","routeSlug":"/docs/dev-docs/api/orders-timeline","items":[{"label":"Retrieve order timeline messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders-timeline/getsubscriptiontimelinecollection","routeSlug":"/docs/dev-docs/api/orders-timeline/getsubscriptiontimelinecollection","metadata":{"seo":{"title":"Retrieve order timeline messages","description":"Retrieves a list of order timeline messages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetSubscriptionTimelineCollection","name":"Retrieve order timeline messages","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1timeline/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve order timeline messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of order timeline messages."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1timeline/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."}],"pointer":"/paths/~1subscriptions~1{id}~1timeline/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions/{id}/timeline","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"q","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/subscriptions/{id}/timeline","href":"orders-timeline/getsubscriptiontimelinecollection","openApiOperationId":"GetSubscriptionTimelineCollection","summary":"Retrieve order timeline messages","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// all parameters are optional except for the `id`\nconst firstCollection = await api.subscriptions\n .getAllTimelineMessages({id: 'my-transaction'});\n\n// alternatively you can specify one or more of them\nconst params = {id: 'my-transaction', limit: 20, offset: 100};\nconst secondCollection = await api.subscriptions.getAllTimelineMessages(params);\n\n// access the collection items, each item is a SubscriptionTimeline\nsecondCollection.items\n .forEach(message => console.log(message.fields.eventType));\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of order timeline messages retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_880"}},"schemaId":"schema_880","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"}],"pointer":"/paths/~1subscriptions~1{id}~1timeline/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_880","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_880"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders-timeline/getsubscriptiontimelinecollection"}],"panels":[]}]},"httpPath":"/subscriptions/{id}/timeline"},{"label":"Create an order timeline comment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders-timeline/postsubscriptiontimeline","routeSlug":"/docs/dev-docs/api/orders-timeline/postsubscriptiontimeline","metadata":{"seo":{"title":"Create an order timeline comment","description":"Creates an order timeline comment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostSubscriptionTimeline","name":"Create an order timeline comment","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1timeline/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an order timeline comment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an order timeline comment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1timeline/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderTimeline"}},"schemaId":"components/schemas/OrderTimeline","pointer":"/paths/~1subscriptions~1{id}~1timeline/post/requestBody","description":"Order Timeline resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions/{id}/timeline","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderTimeline"}},"responseCodes":["201","401","403","422","429"],"pointer":"/subscriptions/{id}/timeline","href":"orders-timeline/postsubscriptiontimeline","openApiOperationId":"PostSubscriptionTimeline","summary":"Create an order timeline comment","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// Create a comment\nconst firstComment = await api\n .subscriptions.createTimelineComment({id: 'my-subscription-id', data: {message: 'Your comment here'}});\n\n// Using params object, mentions and references\nconst message = `Example of mentions @user@mydomain.com and references #subscriptions-subscription-id`;\nconst params = {\n id: 'my-subscription-id',\n data: {\n message,\n },\n};\nconst secondComment = await api.subscriptions.createTimelineComment(params);"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/OrderTimeline","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderTimeline"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Order timeline comment created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderTimeline"}},"schemaId":"components/schemas/OrderTimeline","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscriptions~1{id}~1timeline/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/OrderTimeline","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderTimeline"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders-timeline/postsubscriptiontimeline"}],"panels":[]}]},"httpPath":"/subscriptions/{id}/timeline"},{"label":"Retrieve an order timeline message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders-timeline/getsubscriptiontimeline","routeSlug":"/docs/dev-docs/api/orders-timeline/getsubscriptiontimeline","metadata":{"seo":{"title":"Retrieve an order timeline message","description":"Retrieves an order timeline message with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetSubscriptionTimeline","name":"Retrieve an order timeline message","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1timeline~1{messageId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an order timeline message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an order timeline message with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"messageId","in":"path","schemaId":"schema_782","description":"ID of the order timeline message.","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1timeline~1{messageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions/{id}/timeline/{messageId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"messageId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/subscriptions/{id}/timeline/{messageId}","href":"orders-timeline/getsubscriptiontimeline","openApiOperationId":"GetSubscriptionTimeline","summary":"Retrieve an order timeline message","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const message = await api.subscriptions\n .getTimelineMessage({id: 'foobar-001', messageId: 'message-202'});\nconsole.log(message.fields.eventType);"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order timeline message retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderTimeline"}},"schemaId":"components/schemas/OrderTimeline"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1subscriptions~1{id}~1timeline~1{messageId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderTimeline","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderTimeline"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders-timeline/getsubscriptiontimeline"}],"panels":[]}]},"httpPath":"/subscriptions/{id}/timeline/{messageId}"},{"label":"Delete an order timeline message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/orders-timeline/deletesubscriptiontimeline","routeSlug":"/docs/dev-docs/api/orders-timeline/deletesubscriptiontimeline","metadata":{"seo":{"title":"Delete an order timeline message","description":"Deletes an order timeline message with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteSubscriptionTimeline","name":"Delete an order timeline message","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1timeline~1{messageId}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an order timeline message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an order timeline message with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"messageId","in":"path","schemaId":"schema_782","description":"ID of the order timeline message.","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1timeline~1{messageId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/subscriptions/{id}/timeline/{messageId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"messageId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","409","429"],"pointer":"/subscriptions/{id}/timeline/{messageId}","href":"orders-timeline/deletesubscriptiontimeline","openApiOperationId":"DeleteSubscriptionTimeline","summary":"Delete an order timeline message","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const request = await api.subscriptions\n .deleteTimelineMessage({id: 'foobar-001', messageId: 'message-202'});\n\n// the request does not return any fields but\n// you can confirm the success using the status code\nconsole.log(request.response.status); // 204"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Order timeline message deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1subscriptions~1{id}~1timeline~1{messageId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders-timeline/deletesubscriptiontimeline"}],"panels":[]}]},"httpPath":"/subscriptions/{id}/timeline/{messageId}"}],"content":{"contentType":"group","meta":{"name":"Orders timeline"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders timeline","showPageActions":true},{"nodeType":"markdoc","content":"Use order timelines to maintain an audit trail of changes and activity for each order."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscriptions/{id}/timeline","summary":"Retrieve order timeline messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders-timeline/getsubscriptiontimelinecollection","deprecated":false},{"title":"/subscriptions/{id}/timeline","summary":"Create an order timeline comment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders-timeline/postsubscriptiontimeline","deprecated":false},{"title":"/subscriptions/{id}/timeline/{messageId}","summary":"Retrieve an order timeline message","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders-timeline/getsubscriptiontimeline","deprecated":false},{"title":"/subscriptions/{id}/timeline/{messageId}","summary":"Delete an order timeline message","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/orders-timeline/deletesubscriptiontimeline","deprecated":false}]}]}]}]}},{"type":"group","label":"Invoices timeline","link":"/docs/dev-docs/api/invoices-timeline","routeSlug":"/docs/dev-docs/api/invoices-timeline","items":[{"label":"Retrieve invoice timeline messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices-timeline/getinvoicetimelinecollection","routeSlug":"/docs/dev-docs/api/invoices-timeline/getinvoicetimelinecollection","metadata":{"seo":{"title":"Retrieve invoice timeline messages","description":"Retrieves a list of invoice timeline messages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetInvoiceTimelineCollection","name":"Retrieve invoice timeline messages","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1timeline/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve invoice timeline messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of invoice timeline messages."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1invoices~1{id}~1timeline/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."}],"pointer":"/paths/~1invoices~1{id}~1timeline/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{id}/timeline","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"q","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/invoices/{id}/timeline","href":"invoices-timeline/getinvoicetimelinecollection","openApiOperationId":"GetInvoiceTimelineCollection","summary":"Retrieve invoice timeline messages","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// all parameters are optional except for the `id`\nconst firstCollection = await api.invoices\n .getAllTimelineMessages({id: 'my-invoice'});\n\n// alternatively you can specify one or more of them\nconst params = {id: 'my-invoice', limit: 20, offset: 100};\nconst secondCollection = await api.invoices.getAllTimelineMessages(params);\n\n// access the collection items, each item is an InvoiceTimeline\nsecondCollection.items\n .forEach(message => console.log(message.fields.eventType));\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$timelineMessages = $service->invoices()->getAllTimelineMessages('invoiceId', filter: 'triggeredBy:direct-api');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of invoice timeline messages retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_881"}},"schemaId":"schema_881","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1invoices~1{id}~1timeline/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_881","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_881"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices-timeline/getinvoicetimelinecollection"}],"panels":[]}]},"httpPath":"/invoices/{id}/timeline"},{"label":"Create an invoice timeline comment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices-timeline/postinvoicetimeline","routeSlug":"/docs/dev-docs/api/invoices-timeline/postinvoicetimeline","metadata":{"seo":{"title":"Create an invoice timeline comment","description":"Creates an invoice timeline comment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostInvoiceTimeline","name":"Create an invoice timeline comment","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1timeline/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an invoice timeline comment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an invoice timeline comment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1invoices~1{id}~1timeline/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceTimeline"}},"schemaId":"components/schemas/InvoiceTimeline","pointer":"/paths/~1invoices~1{id}~1timeline/post/requestBody","description":"Invoice Timeline resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{id}/timeline","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceTimeline"}},"responseCodes":["201","401","403","422","429"],"pointer":"/invoices/{id}/timeline","href":"invoices-timeline/postinvoicetimeline","openApiOperationId":"PostInvoiceTimeline","summary":"Create an invoice timeline comment","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// Create a comment\nconst firstComment = await api\n .invoices.createTimelineComment({id: 'my-invoice-id', data: {message: 'Your comment here'}});\n\n// Using params object, mentions and references\nconst message = `Example of mentions @user@mydomain.com and references #invoice-subscription-id`;\nconst params = {\n id: 'my-invoice-id',\n data: {\n message,\n },\n};\nconst secondComment = await api.invoices.createTimelineComment(params);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$timelineMessage = new \\Rebilly\\Sdk\\Model\\InvoiceTimeline([\n 'message' => 'Automatic message',\n]);\n\ntry {\n $timelineMessage = $service->invoices()->createTimelineComment('invoiceId', $timelineMessage);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/InvoiceTimeline","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceTimeline"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Invoice timeline comment created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTimeline"}},"schemaId":"components/schemas/InvoiceTimeline","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1invoices~1{id}~1timeline/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/InvoiceTimeline","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTimeline"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices-timeline/postinvoicetimeline"}],"panels":[]}]},"httpPath":"/invoices/{id}/timeline"},{"label":"Retrieve an invoice timeline message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices-timeline/getinvoicetimeline","routeSlug":"/docs/dev-docs/api/invoices-timeline/getinvoicetimeline","metadata":{"seo":{"title":"Retrieve an invoice timeline message","description":"Retrieves an invoice timeline message with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetInvoiceTimeline","name":"Retrieve an invoice timeline message","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1timeline~1{messageId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an invoice timeline message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an invoice timeline message with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"messageId","in":"path","schemaId":"schema_782","description":"ID of the invoice timeline message.","required":true}],"pointer":"/paths/~1invoices~1{id}~1timeline~1{messageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{id}/timeline/{messageId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"messageId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/invoices/{id}/timeline/{messageId}","href":"invoices-timeline/getinvoicetimeline","openApiOperationId":"GetInvoiceTimeline","summary":"Retrieve an invoice timeline message","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const message = await api.invoices\n .getTimelineMessage({id: 'foobar-001', messageId: 'message-202'});\nconsole.log(message.fields.eventType);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$timelineMessage = $service->invoices()->getTimelineMessage('invoiceId', 'messageId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Invoice message retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTimeline"}},"schemaId":"components/schemas/InvoiceTimeline"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1invoices~1{id}~1timeline~1{messageId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceTimeline","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTimeline"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices-timeline/getinvoicetimeline"}],"panels":[]}]},"httpPath":"/invoices/{id}/timeline/{messageId}"},{"label":"Delete an invoice timeline message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/invoices-timeline/deleteinvoicetimeline","routeSlug":"/docs/dev-docs/api/invoices-timeline/deleteinvoicetimeline","metadata":{"seo":{"title":"Delete an invoice timeline message","description":"Deletes an invoice timeline message with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteInvoiceTimeline","name":"Delete an invoice timeline message","isWebhook":false,"pointer":"/paths/~1invoices~1{id}~1timeline~1{messageId}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an invoice timeline message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an invoice timeline message with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"messageId","in":"path","schemaId":"schema_782","description":"ID of the invoice timeline message.","required":true}],"pointer":"/paths/~1invoices~1{id}~1timeline~1{messageId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/invoices/{id}/timeline/{messageId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"messageId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","409","429"],"pointer":"/invoices/{id}/timeline/{messageId}","href":"invoices-timeline/deleteinvoicetimeline","openApiOperationId":"DeleteInvoiceTimeline","summary":"Delete an invoice timeline message","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const request = await api.invoices\n .deleteTimelineMessage({id: 'foobar-001', messageId: 'message-202'});\n\n// the request does not return any fields but\n// you can confirm the success using the status code\nconsole.log(request.response.status); // 204"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$service->invoices()->deleteTimelineMessage('invoiceId', 'messageId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Invoice timeline message deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1invoices~1{id}~1timeline~1{messageId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices-timeline/deleteinvoicetimeline"}],"panels":[]}]},"httpPath":"/invoices/{id}/timeline/{messageId}"}],"content":{"contentType":"group","meta":{"name":"Invoices timeline"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoices timeline","showPageActions":true},{"nodeType":"markdoc","content":"Use invoice timelines to maintain an audit trail of changes and activity for each invoice."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/invoices/{id}/timeline","summary":"Retrieve invoice timeline messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices-timeline/getinvoicetimelinecollection","deprecated":false},{"title":"/invoices/{id}/timeline","summary":"Create an invoice timeline comment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices-timeline/postinvoicetimeline","deprecated":false},{"title":"/invoices/{id}/timeline/{messageId}","summary":"Retrieve an invoice timeline message","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices-timeline/getinvoicetimeline","deprecated":false},{"title":"/invoices/{id}/timeline/{messageId}","summary":"Delete an invoice timeline message","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/invoices-timeline/deleteinvoicetimeline","deprecated":false}]}]}]}]}},{"type":"group","label":"Credit memos timeline","link":"/docs/dev-docs/api/credit-memos-timeline","routeSlug":"/docs/dev-docs/api/credit-memos-timeline","items":[{"label":"Retrieve credit memo timeline messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos-timeline/getcreditmemotimelinecollection","routeSlug":"/docs/dev-docs/api/credit-memos-timeline/getcreditmemotimelinecollection","metadata":{"seo":{"title":"Retrieve credit memo timeline messages","description":"Retrieves a list of credit memo timeline messages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCreditMemoTimelineCollection","name":"Retrieve credit memo timeline messages","isWebhook":false,"pointer":"/paths/~1credit-memos~1{id}~1timeline/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve credit memo timeline messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of credit memo timeline messages."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1credit-memos~1{id}~1timeline/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."}],"pointer":"/paths/~1credit-memos~1{id}~1timeline/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credit-memos/{id}/timeline","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"q","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/credit-memos/{id}/timeline","href":"credit-memos-timeline/getcreditmemotimelinecollection","openApiOperationId":"GetCreditMemoTimelineCollection","summary":"Retrieve credit memo timeline messages","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of credit memo timeline messages retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_882"}},"schemaId":"schema_882","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1credit-memos~1{id}~1timeline/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_882","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_882"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos-timeline/getcreditmemotimelinecollection"}],"panels":[]}]},"httpPath":"/credit-memos/{id}/timeline"},{"label":"Create a credit memo timeline message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos-timeline/postcreditmemotimeline","routeSlug":"/docs/dev-docs/api/credit-memos-timeline/postcreditmemotimeline","metadata":{"seo":{"title":"Create a credit memo timeline message","description":"Creates a credit memo timeline message."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostCreditMemoTimeline","name":"Create a credit memo timeline message","isWebhook":false,"pointer":"/paths/~1credit-memos~1{id}~1timeline/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a credit memo timeline message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a credit memo timeline message."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1credit-memos~1{id}~1timeline/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemoTimeline"}},"schemaId":"components/schemas/CreditMemoTimeline","pointer":"/paths/~1credit-memos~1{id}~1timeline/post/requestBody","description":"Credit memo timeline resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/credit-memos/{id}/timeline","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditMemoTimeline"}},"responseCodes":["201","401","403","422","429"],"pointer":"/credit-memos/{id}/timeline","href":"credit-memos-timeline/postcreditmemotimeline","openApiOperationId":"PostCreditMemoTimeline","summary":"Create a credit memo timeline message","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/CreditMemoTimeline","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemoTimeline"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Credit memo timeline message created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemoTimeline"}},"schemaId":"components/schemas/CreditMemoTimeline","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1credit-memos~1{id}~1timeline/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreditMemoTimeline","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemoTimeline"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos-timeline/postcreditmemotimeline"}],"panels":[]}]},"httpPath":"/credit-memos/{id}/timeline"},{"label":"Retrieve a credit memo timeline message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos-timeline/getcreditmemotimeline","routeSlug":"/docs/dev-docs/api/credit-memos-timeline/getcreditmemotimeline","metadata":{"seo":{"title":"Retrieve a credit memo timeline message","description":"Retrieves a credit memo timeline message with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCreditMemoTimeline","name":"Retrieve a credit memo timeline message","isWebhook":false,"pointer":"/paths/~1credit-memos~1{id}~1timeline~1{messageId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a credit memo timeline message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a credit memo timeline message with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"messageId","in":"path","schemaId":"schema_782","description":"ID of the credit memo timeline message.","required":true}],"pointer":"/paths/~1credit-memos~1{id}~1timeline~1{messageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credit-memos/{id}/timeline/{messageId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"messageId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/credit-memos/{id}/timeline/{messageId}","href":"credit-memos-timeline/getcreditmemotimeline","openApiOperationId":"GetCreditMemoTimeline","summary":"Retrieve a credit memo timeline message","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Credit memo timeline message retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemoTimeline"}},"schemaId":"components/schemas/CreditMemoTimeline"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1credit-memos~1{id}~1timeline~1{messageId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditMemoTimeline","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemoTimeline"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos-timeline/getcreditmemotimeline"}],"panels":[]}]},"httpPath":"/credit-memos/{id}/timeline/{messageId}"},{"label":"Delete a credit memo timeline message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/credit-memos-timeline/deletecreditmemotimeline","routeSlug":"/docs/dev-docs/api/credit-memos-timeline/deletecreditmemotimeline","metadata":{"seo":{"title":"Delete a credit memo timeline message","description":"Deletes a credit memo timeline message with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteCreditMemoTimeline","name":"Delete a credit memo timeline message","isWebhook":false,"pointer":"/paths/~1credit-memos~1{id}~1timeline~1{messageId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a credit memo timeline message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a credit memo timeline message with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true},{"name":"messageId","in":"path","schemaId":"schema_782","description":"ID of the credit memo timeline message.","required":true}],"pointer":"/paths/~1credit-memos~1{id}~1timeline~1{messageId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/credit-memos/{id}/timeline/{messageId}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"},{"name":"messageId","in":"path","required":true,"schemaId":"schema_782"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","409","429"],"pointer":"/credit-memos/{id}/timeline/{messageId}","href":"credit-memos-timeline/deletecreditmemotimeline","openApiOperationId":"DeleteCreditMemoTimeline","summary":"Delete a credit memo timeline message","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Credit memo timeline message deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1credit-memos~1{id}~1timeline~1{messageId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos-timeline/deletecreditmemotimeline"}],"panels":[]}]},"httpPath":"/credit-memos/{id}/timeline/{messageId}"}],"content":{"contentType":"group","meta":{"name":"Credit memos timeline"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit memos timeline","showPageActions":true},{"nodeType":"markdoc","content":"Use credit memo timelines to maintain an audit trail of changes and activity for each credit memo.\nCredit memos are a means of providing a customer with store credit."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/credit-memos/{id}/timeline","summary":"Retrieve credit memo timeline messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos-timeline/getcreditmemotimelinecollection","deprecated":false},{"title":"/credit-memos/{id}/timeline","summary":"Create a credit memo timeline message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos-timeline/postcreditmemotimeline","deprecated":false},{"title":"/credit-memos/{id}/timeline/{messageId}","summary":"Retrieve a credit memo timeline message","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos-timeline/getcreditmemotimeline","deprecated":false},{"title":"/credit-memos/{id}/timeline/{messageId}","summary":"Delete a credit memo timeline message","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/credit-memos-timeline/deletecreditmemotimeline","deprecated":false}]}]}]}]}},{"type":"separator","label":"Risk","content":null},{"type":"group","label":"Blocklists","link":"/docs/dev-docs/api/blocklists","routeSlug":"/docs/dev-docs/api/blocklists","items":[{"label":"Retrieve blocklists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/blocklists/getblocklistcollection","routeSlug":"/docs/dev-docs/api/blocklists/getblocklistcollection","metadata":{"seo":{"title":"Retrieve blocklists","description":"Retrieves a list of all blocklists."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetBlocklistCollection","name":"Retrieve blocklists","isWebhook":false,"pointer":"/paths/~1blocklists/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve blocklists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all blocklists."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."}],"pointer":"/paths/~1blocklists/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/blocklists","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"q","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/blocklists","href":"blocklists/getblocklistcollection","openApiOperationId":"GetBlocklistCollection","summary":"Retrieve blocklists","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$blocklists = $client->blocklists()->search([\n 'filter' => 'value:testValue',\n]);\n"},{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.blocklists.getAll();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100, sort: '-createdTime'};\nconst secondCollection = await api.blocklists.getAll(params);\n\n// access the collection items, each item is a Blocklist\nsecondCollection.items.forEach(blocklistItem => console.log(blocklistItem.fields.status));\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$blocklistsPaginator = $service->blocklists()->getAllPaginator(limit: 5, filter: 'value:testValue');\nforeach ($blocklistsPaginator as $blocklistPage) {\n printf(\"Blocklists page %d/%d\\n\", $blocklistsPaginator->key() + 1, $blocklistsPaginator->count());\n foreach ($blocklistPage as $blocklist) {\n printf(\"Blocklist #%s (%s): %s\\n\", $blocklist->getId(), $blocklist->getType(), $blocklist->getValue());\n }\n}\n\n// OR\n\n$blocklists = $service->blocklists()->getAll(filter: 'value:testValue');\nforeach ($blocklists as $blocklist) {\n printf(\"Blocklist #%s (%s): %s\\n\", $blocklist->getId(), $blocklist->getType(), $blocklist->getValue());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of blocklists retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_883"}},"schemaId":"schema_883","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1blocklists/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_883","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_883"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/blocklists/getblocklistcollection"}],"panels":[]}]},"httpPath":"/blocklists"},{"label":"Create a blocklist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/blocklists/postblocklist","routeSlug":"/docs/dev-docs/api/blocklists/postblocklist","metadata":{"seo":{"title":"Create a blocklist","description":"Creates a blocklist."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostBlocklist","name":"Create a blocklist","isWebhook":false,"pointer":"/paths/~1blocklists/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a blocklist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a blocklist."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Blocklist"}},"schemaId":"components/schemas/Blocklist","pointer":"/paths/~1blocklists/post/requestBody","description":"Blocklist resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/blocklists","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Blocklist"}},"responseCodes":["201","401","403","409","422","429"],"pointer":"/blocklists","href":"blocklists/postblocklist","openApiOperationId":"PostBlocklist","summary":"Create a blocklist","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$blocklistForm = new Rebilly\\Entities\\Blocklist();\n$blocklistForm->setType($blocklistForm::TYPE_EMAIL);\n$blocklistForm->setValue('test@test.com');\n$blocklistForm->setExpiredTime('2025-01-01 05:00:00');\n\ntry {\n $blocklist = $client->blocklists()->create($blocklistForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the required properties for the new blocklist item\nconst data = {\n type: 'ip-address',\n value: '63.118.98.100'\n\n // optionally provide an `expirationTime` to make\n // the item expire and function like a `greylist`\n\n // expirationTime: '2017-09-18T21:50:44Z'\n};\n\n// the ID is optional\nconst firstKey = await api.blocklists.create({data});\n\n// or you can provide one\nconst secondKey = await api.blocklists.create({id: 'my-second-id', data});\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$blocklistForm = new \\Rebilly\\Sdk\\Model\\Blocklist();\n$blocklistForm->setType($blocklistForm::TYPE_EMAIL);\n$blocklistForm->setValue('test@test.com');\n$blocklistForm->setExpirationTime('2025-01-01 05:00:00');\n\ntry {\n $blocklist = $service->blocklists()->create($blocklistForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Blocklist","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Blocklist"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Blocklist created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blocklist"}},"schemaId":"components/schemas/Blocklist","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1blocklists/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Blocklist","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blocklist"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/blocklists/postblocklist"}],"panels":[]}]},"httpPath":"/blocklists"},{"label":"Retrieve a blocklist","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/blocklists/getblocklist","routeSlug":"/docs/dev-docs/api/blocklists/getblocklist","metadata":{"seo":{"title":"Retrieve a blocklist","description":"Retrieves a blocklist with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetBlocklist","name":"Retrieve a blocklist","isWebhook":false,"pointer":"/paths/~1blocklists~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a blocklist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a blocklist with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1blocklists~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/blocklists/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/blocklists/{id}","href":"blocklists/getblocklist","openApiOperationId":"GetBlocklist","summary":"Retrieve a blocklist","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$blocklist = $client->blocklists()->load('blocklistId');\n"},{"lang":"JavaScript","source":"const blocklistItem = await api.blocklists.get({id: 'foobar-001'});\nconsole.log(blocklistItem.fields.status);\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$blocklist = $service->blocklists()->get('blocklistId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Blocklist retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blocklist"}},"schemaId":"components/schemas/Blocklist"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1blocklists~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Blocklist","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blocklist"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/blocklists/getblocklist"}],"panels":[]}]},"httpPath":"/blocklists/{id}"},{"label":"Create a blocklist with specified ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/blocklists/putblocklist","routeSlug":"/docs/dev-docs/api/blocklists/putblocklist","metadata":{"seo":{"title":"Create a blocklist with specified ID","description":"Creates a blocklist with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutBlocklist","name":"Create a blocklist with specified ID","isWebhook":false,"pointer":"/paths/~1blocklists~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a blocklist with specified ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a blocklist with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1blocklists~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Blocklist"}},"schemaId":"components/schemas/Blocklist","pointer":"/paths/~1blocklists~1{id}/put/requestBody","description":"Blocklist resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/blocklists/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Blocklist"}},"responseCodes":["200","201","401","403","409","422","429"],"pointer":"/blocklists/{id}","href":"blocklists/putblocklist","openApiOperationId":"PutBlocklist","summary":"Create a blocklist with specified ID","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$blocklistForm = new Rebilly\\Entities\\Blocklist();\n$blocklistForm->setType($blocklistForm::TYPE_EMAIL);\n$blocklistForm->setValue('test@test.com');\n$blocklistForm->setExpiredTime('2025-01-01 05:00:00');\n\ntry {\n $blocklist = $client->blocklists()->create($blocklistForm, 'blocklistId');\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// first set the required properties for the new blocklist item\nconst data = {\n type: 'ip-address',\n value: '63.118.98.100'\n\n // optionally provide an `expirationTime` to make\n // the item expire and function like a `greylist`\n\n // expirationTime: '2017-09-18T21:50:44Z'\n};\n\n// the ID is optional\nconst firstKey = await api.blocklists.create({data});\n\n// or you can provide one\nconst secondKey = await api.blocklists.create({id: 'my-second-id', data});\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$blocklistForm = new \\Rebilly\\Sdk\\Model\\Blocklist();\n$blocklistForm->setType($blocklistForm::TYPE_EMAIL);\n$blocklistForm->setValue('test@test.com');\n$blocklistForm->setExpirationTime('2025-01-01 05:00:00');\n\ntry {\n $blocklist = $service->blocklists()->update('blocklistId', $blocklistForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Blocklist","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Blocklist"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Blocklist updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blocklist"}},"schemaId":"components/schemas/Blocklist"},{"code":"201","description":"Blocklist created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blocklist"}},"schemaId":"components/schemas/Blocklist","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1blocklists~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Blocklist","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blocklist"}}},{"code":"201","schemaId":"components/schemas/Blocklist","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blocklist"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/blocklists/putblocklist"}],"panels":[]}]},"httpPath":"/blocklists/{id}"},{"label":"Delete a blocklist","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/blocklists/deleteblocklist","routeSlug":"/docs/dev-docs/api/blocklists/deleteblocklist","metadata":{"seo":{"title":"Delete a blocklist","description":"Deletes a blocklist with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteBlocklist","name":"Delete a blocklist","isWebhook":false,"pointer":"/paths/~1blocklists~1{id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a blocklist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a blocklist with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1blocklists~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/blocklists/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","429"],"pointer":"/blocklists/{id}","href":"blocklists/deleteblocklist","openApiOperationId":"DeleteBlocklist","summary":"Delete a blocklist","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$client->blocklists()->delete('blocklistId');\n"},{"lang":"JavaScript","source":"const request = await api.blocklists.delete({id: 'my-second-key'});\n\n// the request does not return any fields but\n// you can confirm the success using the status code\nconsole.log(request.response.status); // 204\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$service->blocklists()->delete('blocklistId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Blocklist deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1blocklists~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/blocklists/deleteblocklist"}],"panels":[]}]},"httpPath":"/blocklists/{id}"}],"content":{"contentType":"group","meta":{"name":"Blocklists"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Blocklists","showPageActions":true},{"nodeType":"markdoc","content":"Use blocklists to prevent fraud and criminal activity.\n\nBlocklists are lists of customer attribute values that are blocked from buying from you.\nFor example, if a customer attempts to make a purchase from you with a credit card that is in a blocklist, the transaction is blocked and is not processed.\n\nBefore a new transaction is processed in Rebilly, blocklists are examined to check for attributes related to the entity.\nIf a match is detected, the operation is aborted.\nA blocklist that expires after a period of time is called a greylist."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/blocklists","summary":"Retrieve blocklists","prefix":{"name":"get","color":"get"},"badges":[],"link":"/blocklists/getblocklistcollection","deprecated":false},{"title":"/blocklists","summary":"Create a blocklist","prefix":{"name":"post","color":"post"},"badges":[],"link":"/blocklists/postblocklist","deprecated":false},{"title":"/blocklists/{id}","summary":"Retrieve a blocklist","prefix":{"name":"get","color":"get"},"badges":[],"link":"/blocklists/getblocklist","deprecated":false},{"title":"/blocklists/{id}","summary":"Create a blocklist with specified ID","prefix":{"name":"put","color":"put"},"badges":[],"link":"/blocklists/putblocklist","deprecated":false},{"title":"/blocklists/{id}","summary":"Delete a blocklist","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/blocklists/deleteblocklist","deprecated":false}]}]}]}]}},{"type":"group","label":"Allowlists","link":"/docs/dev-docs/api/allowlists","routeSlug":"/docs/dev-docs/api/allowlists","items":[{"label":"Retrieve allowlist collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/allowlists/getallowlistcollection","routeSlug":"/docs/dev-docs/api/allowlists/getallowlistcollection","metadata":{"seo":{"title":"Retrieve allowlist collection","description":"Retrieves allowlist collection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetAllowlistCollection","name":"Retrieve allowlist collection","isWebhook":false,"pointer":"/paths/~1allowlists/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve allowlist collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves allowlist collection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."}],"pointer":"/paths/~1allowlists/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/allowlists","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/allowlists","href":"allowlists/getallowlistcollection","openApiOperationId":"GetAllowlistCollection","summary":"Retrieve allowlist collection","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Allowlist collection retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_884"}},"schemaId":"schema_884"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1allowlists/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_884","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_884"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/allowlists/getallowlistcollection"}],"panels":[]}]},"httpPath":"/allowlists"},{"label":"Create allowlist record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/allowlists/postallowlist","routeSlug":"/docs/dev-docs/api/allowlists/postallowlist","metadata":{"seo":{"title":"Create allowlist record","description":"Creates allowlist record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostAllowlist","name":"Create allowlist record","isWebhook":false,"pointer":"/paths/~1allowlists/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create allowlist record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates allowlist record."},{"nodeType":"security","requirements":[{"schemes":[{"name":"PublishableApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This authentication method is applicable to specific operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a publishable API key, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/api-keys/postapikey"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an API key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Allowlist"}},"schemaId":"components/schemas/Allowlist","pointer":"/paths/~1allowlists/post/requestBody","description":"Allowlist record."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/allowlists","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"PublishableApiKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Allowlist"}},"responseCodes":["201","401","409","429"],"pointer":"/allowlists","href":"allowlists/postallowlist","openApiOperationId":"PostAllowlist","summary":"Create allowlist record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Allowlist","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Allowlist"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Allowlist record created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Allowlist"}},"schemaId":"components/schemas/Allowlist","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1allowlists/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Allowlist","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Allowlist"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/allowlists/postallowlist"}],"panels":[]}]},"httpPath":"/allowlists"},{"label":"Retrieve allowlist record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/allowlists/getallowlist","routeSlug":"/docs/dev-docs/api/allowlists/getallowlist","metadata":{"seo":{"title":"Retrieve allowlist record","description":"Retrieves allowlist record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetAllowlist","name":"Retrieve allowlist record","isWebhook":false,"pointer":"/paths/~1allowlists~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve allowlist record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves allowlist record."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1allowlists~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/allowlists/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/allowlists/{id}","href":"allowlists/getallowlist","openApiOperationId":"GetAllowlist","summary":"Retrieve allowlist record","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Allowlist record retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Allowlist"}},"schemaId":"components/schemas/Allowlist","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1allowlists~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Allowlist","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Allowlist"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/allowlists/getallowlist"}],"panels":[]}]},"httpPath":"/allowlists/{id}"},{"label":"Delete allowlist record","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/allowlists/deleteallowlist","routeSlug":"/docs/dev-docs/api/allowlists/deleteallowlist","metadata":{"seo":{"title":"Delete allowlist record","description":"Deletes allowlist record with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteAllowlist","name":"Delete allowlist record","isWebhook":false,"pointer":"/paths/~1allowlists~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete allowlist record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes allowlist record with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1allowlists~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/allowlists/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","429"],"pointer":"/allowlists/{id}","href":"allowlists/deleteallowlist","openApiOperationId":"DeleteAllowlist","summary":"Delete allowlist record","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Allowlist record deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1allowlists~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/allowlists/deleteallowlist"}],"panels":[]}]},"httpPath":"/allowlists/{id}"}],"content":{"contentType":"group","meta":{"name":"Allowlists"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Allowlists","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use allowlists to exclude specific customer attribute data from risk score checks."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowlists are lists of data that are excluded from risk score checks. Allowlists prevent specific data from being added to a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/automations/blocklists/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"blocklist record"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/automations/risk-scoring/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"risk score"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" threshold reached."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/allowlists","summary":"Retrieve allowlist collection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/allowlists/getallowlistcollection","deprecated":false},{"title":"/allowlists","summary":"Create allowlist record","prefix":{"name":"post","color":"post"},"badges":[],"link":"/allowlists/postallowlist","deprecated":false},{"title":"/allowlists/{id}","summary":"Retrieve allowlist record","prefix":{"name":"get","color":"get"},"badges":[],"link":"/allowlists/getallowlist","deprecated":false},{"title":"/allowlists/{id}","summary":"Delete allowlist record","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/allowlists/deleteallowlist","deprecated":false}]}]}]}]}},{"type":"group","label":"KYC documents","link":"/docs/dev-docs/api/kyc-documents","routeSlug":"/docs/dev-docs/api/kyc-documents","items":[{"type":"link","label":"Credit file proof","link":"/docs/dev-docs/api/kyc-documents/credit-file-proof","routeSlug":"/docs/dev-docs/api/kyc-documents/credit-file-proof","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Credit file proof"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"kyc-documents/credit-file-proof"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit file proof"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit-file-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" KYC document request type is only available in the API,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this option is not available in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/kyc-and-aml/kyc-document-gatherer/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC document gatherer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This request verifies that there is an existing credit file with two sources that match the person's name, date of birth, and address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Canada, to meet FINTRAC requirements, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit-file-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" KYC document request verifies the customer's name, address, and date of birth with a credit agency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit-file-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is requested in combination with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit-file-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is attempted first."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit-file-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" validates the identity and address,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the KYC request is considered fulfilled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the request is not fulfilled,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"redirect your customer to the KYC document gatherer to collect their KYC documents."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"Create a KYC request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/postkycrequest","routeSlug":"/docs/dev-docs/api/kyc-documents/postkycrequest","metadata":{"seo":{"title":"Create a KYC request","description":"Creates a KYC request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostKycRequest","name":"Create a KYC request","isWebhook":false,"pointer":"/paths/~1kyc-requests/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a KYC request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a KYC request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer is redirected to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kycGatherer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" link."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the customer completes the KYC process,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"they are redirected back to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirectUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" link."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Corresponding webhooks, such as: KYC document accepted and KYC document rejected,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are sent to the subscribers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the complete list of documents is received and accepted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the KYC request fulfilled webhook is sent to subscribers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit-file-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request is successful,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"decision"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"single-source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dual-source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" documents are not requested."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KycRequest","exampleIds":["paths/~1kyc-requests/post/requestBody/content/application~1json/examples/credit-file-identity-address","paths/~1kyc-requests/post/requestBody/content/application~1json/examples/identity-with-face-proof","paths/~1kyc-requests/post/requestBody/content/application~1json/examples/identity-and-address"]}},"schemaId":"components/schemas/KycRequest","exampleIds":["paths/~1kyc-requests/post/requestBody/content/application~1json/examples/credit-file-identity-address","paths/~1kyc-requests/post/requestBody/content/application~1json/examples/identity-with-face-proof","paths/~1kyc-requests/post/requestBody/content/application~1json/examples/identity-and-address"],"pointer":"/paths/~1kyc-requests/post/requestBody","description":"KYC request resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/kyc-requests","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/KycRequest","exampleIds":["paths/~1kyc-requests/post/requestBody/content/application~1json/examples/credit-file-identity-address","paths/~1kyc-requests/post/requestBody/content/application~1json/examples/identity-with-face-proof","paths/~1kyc-requests/post/requestBody/content/application~1json/examples/identity-and-address"]}},"responseCodes":["201","401","403","422","429"],"pointer":"/kyc-requests","href":"kyc-documents/postkycrequest","openApiOperationId":"PostKycRequest","summary":"Create a KYC request","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/KycRequest","exampleIds":["paths/~1kyc-requests/post/requestBody/content/application~1json/examples/credit-file-identity-address","paths/~1kyc-requests/post/requestBody/content/application~1json/examples/identity-with-face-proof","paths/~1kyc-requests/post/requestBody/content/application~1json/examples/identity-and-address"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KycRequest","exampleIds":["paths/~1kyc-requests/post/requestBody/content/application~1json/examples/credit-file-identity-address","paths/~1kyc-requests/post/requestBody/content/application~1json/examples/identity-with-face-proof","paths/~1kyc-requests/post/requestBody/content/application~1json/examples/identity-and-address"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"KYC request created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycRequest"}},"schemaId":"components/schemas/KycRequest","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1kyc-requests/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/KycRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycRequest"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/postkycrequest"}],"panels":[]}]},"httpPath":"/kyc-requests"},{"label":"Retrieve KYC requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/getkycrequestcollection","routeSlug":"/docs/dev-docs/api/kyc-documents/getkycrequestcollection","metadata":{"seo":{"title":"Retrieve KYC requests","description":"Retrieves a list of KYC requests."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetKycRequestCollection","name":"Retrieve KYC requests","isWebhook":false,"pointer":"/paths/~1kyc-requests/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve KYC requests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of KYC requests."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1kyc-requests/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/kyc-requests","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/kyc-requests","href":"kyc-documents/getkycrequestcollection","openApiOperationId":"GetKycRequestCollection","summary":"Retrieve KYC requests","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of KYC requests retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_885"}},"schemaId":"schema_885","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1kyc-requests/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_885","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_885"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/getkycrequestcollection"}],"panels":[]}]},"httpPath":"/kyc-requests"},{"label":"Retrieve a KYC request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/getkycrequest","routeSlug":"/docs/dev-docs/api/kyc-documents/getkycrequest","metadata":{"seo":{"title":"Retrieve a KYC request","description":"Retrieves a KYC request with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetKycRequest","name":"Retrieve a KYC request","isWebhook":false,"pointer":"/paths/~1kyc-requests~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a KYC request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a KYC request with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1kyc-requests~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/kyc-requests/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/kyc-requests/{id}","href":"kyc-documents/getkycrequest","openApiOperationId":"GetKycRequest","summary":"Retrieve a KYC request","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"KYC request retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycRequest"}},"schemaId":"components/schemas/KycRequest"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1kyc-requests~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KycRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycRequest"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/getkycrequest"}],"panels":[]}]},"httpPath":"/kyc-requests/{id}"},{"label":"Update a KYC request","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/patchkycrequest","routeSlug":"/docs/dev-docs/api/kyc-documents/patchkycrequest","metadata":{"seo":{"title":"Update a KYC request","description":"Updates a KYC request with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PatchKycRequest","name":"Update a KYC request","isWebhook":false,"pointer":"/paths/~1kyc-requests~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a KYC request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a KYC request with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1kyc-requests~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_886"}},"schemaId":"schema_886","pointer":"/paths/~1kyc-requests~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/kyc-requests/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_886"}},"responseCodes":["200","401","403","404","422","429"],"pointer":"/kyc-requests/{id}","href":"kyc-documents/patchkycrequest","openApiOperationId":"PatchKycRequest","summary":"Update a KYC request","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_886","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_886"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"KYC request updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycRequest"}},"schemaId":"components/schemas/KycRequest","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1kyc-requests~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KycRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycRequest"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/patchkycrequest"}],"panels":[]}]},"httpPath":"/kyc-requests/{id}"},{"label":"Delete the KYC request","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/deletekycrequest","routeSlug":"/docs/dev-docs/api/kyc-documents/deletekycrequest","metadata":{"seo":{"title":"Delete the KYC request","description":"Deletes a KYC request with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteKycRequest","name":"Delete the KYC request","isWebhook":false,"pointer":"/paths/~1kyc-requests~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the KYC request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a KYC request with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1kyc-requests~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/kyc-requests/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","404","429"],"pointer":"/kyc-requests/{id}","href":"kyc-documents/deletekycrequest","openApiOperationId":"DeleteKycRequest","summary":"Delete the KYC request","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"KYC request deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1kyc-requests~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/deletekycrequest"}],"panels":[]}]},"httpPath":"/kyc-requests/{id}"},{"label":"Retrieve KYC documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/getkycdocumentcollection","routeSlug":"/docs/dev-docs/api/kyc-documents/getkycdocumentcollection","metadata":{"seo":{"title":"Retrieve KYC documents","description":"Retrieves a list of KYC documents."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetKycDocumentCollection","name":"Retrieve KYC documents","isWebhook":false,"pointer":"/paths/~1kyc-documents/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve KYC documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of KYC documents."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1kyc-documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/kyc-documents","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"expand","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/kyc-documents","href":"kyc-documents/getkycdocumentcollection","openApiOperationId":"GetKycDocumentCollection","summary":"Retrieve KYC documents","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.kycDocuments.getAll();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100, sort: '-createdTime'};\nconst secondCollection = await api.kycDocuments.getAll(params);\n\n// access the collection items, each item is a KycDocument\nsecondCollection.items.forEach(document => console.log(document.fields.documentType));\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of KYC documents retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_887"}},"schemaId":"schema_887","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1kyc-documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_887","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_887"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/getkycdocumentcollection"}],"panels":[]}]},"httpPath":"/kyc-documents"},{"label":"Create a KYC document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/postkycdocument","routeSlug":"/docs/dev-docs/api/kyc-documents/postkycdocument","metadata":{"seo":{"title":"Create a KYC document","description":"Creates a KYC document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostKycDocument","name":"Create a KYC document","isWebhook":false,"pointer":"/paths/~1kyc-documents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a KYC document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a KYC document."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KycDocument"}},"schemaId":"components/schemas/KycDocument","pointer":"/paths/~1kyc-documents/post/requestBody","description":"Kyc document resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/kyc-documents","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/KycDocument"}},"responseCodes":["201","401","403","422","429"],"pointer":"/kyc-documents","href":"kyc-documents/postkycdocument","openApiOperationId":"PostKycDocument","summary":"Create a KYC document","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// All fields are required\nconst data = {\n fieldId: '4f6cf35x-2c4y-483z-a0a9-158621f77a21',\n customerId: '4f6cf35x-2c4y-483z-a0a9-158621f77a21',\n documentType: 'identity-proof'\n};\n\nconst firstKycDocument = await api.kycDocuments.create({data});"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/KycDocument","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KycDocument"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"KYC document created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}},"schemaId":"components/schemas/KycDocument","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1kyc-documents/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/KycDocument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/postkycdocument"}],"panels":[]}]},"httpPath":"/kyc-documents"},{"label":"Retrieve a KYC document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/getkycdocument","routeSlug":"/docs/dev-docs/api/kyc-documents/getkycdocument","metadata":{"seo":{"title":"Retrieve a KYC document","description":"Retrieves a KYC document with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetKycDocument","name":"Retrieve a KYC document","isWebhook":false,"pointer":"/paths/~1kyc-documents~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a KYC document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a KYC document with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1kyc-documents~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/kyc-documents/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/kyc-documents/{id}","href":"kyc-documents/getkycdocument","openApiOperationId":"GetKycDocument","summary":"Retrieve a KYC document","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const document = await api.kycDocuments.get({id: 'foobar-001'});\nconsole.log(document.fields.documentType);"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"KYC document retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}},"schemaId":"components/schemas/KycDocument"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1kyc-documents~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KycDocument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/getkycdocument"}],"panels":[]}]},"httpPath":"/kyc-documents/{id}"},{"label":"Upsert a KYC document","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/putkycdocument","routeSlug":"/docs/dev-docs/api/kyc-documents/putkycdocument","metadata":{"seo":{"title":"Upsert a KYC document","description":"Creates or updates (upserts) a KYC document with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutKycDocument","name":"Upsert a KYC document","isWebhook":false,"pointer":"/paths/~1kyc-documents~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a KYC document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or updates (upserts) a KYC document with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1kyc-documents~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KycDocument"}},"schemaId":"components/schemas/KycDocument","pointer":"/paths/~1kyc-documents~1{id}/put/requestBody","description":"KYC document resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/kyc-documents/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/KycDocument"}},"responseCodes":["200","201","401","403","404","422","429"],"pointer":"/kyc-documents/{id}","href":"kyc-documents/putkycdocument","openApiOperationId":"PutKycDocument","summary":"Upsert a KYC document","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"// define the values to update\nconst data = {\n status: 'accepted'\n};\n\nconst document = await api.kycDocuments.update({id: 'my-second-id', data});"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/KycDocument","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KycDocument"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"KYC document updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}},"schemaId":"components/schemas/KycDocument","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"KYC document created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}},"schemaId":"components/schemas/KycDocument","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1kyc-documents~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KycDocument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}}},{"code":"201","schemaId":"components/schemas/KycDocument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/putkycdocument"}],"panels":[]}]},"httpPath":"/kyc-documents/{id}"},{"label":"Accept a KYC document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/postkycdocumentacceptance","routeSlug":"/docs/dev-docs/api/kyc-documents/postkycdocumentacceptance","metadata":{"seo":{"title":"Accept a KYC document","description":"Accepts a KYC document and changes the documents status to accepted.The review time and reviewer information is also updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostKycDocumentAcceptance","name":"Accept a KYC document","isWebhook":false,"pointer":"/paths/~1kyc-documents~1{id}~1acceptance/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accept a KYC document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepts a KYC document and changes the documents "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The review time and reviewer information is also updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use this operation for manual overrides."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1kyc-documents~1{id}~1acceptance/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/kyc-documents/{id}/acceptance","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","401","403","404","429"],"pointer":"/kyc-documents/{id}/acceptance","href":"kyc-documents/postkycdocumentacceptance","openApiOperationId":"PostKycDocumentAcceptance","summary":"Accept a KYC document","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const acceptedDocument = await api.kycDocuments.accept({id: 'my-second-id'});\nconsole.log(acceptedDocument.fields.status);"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"KYC document acceptance created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}},"schemaId":"components/schemas/KycDocument","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1kyc-documents~1{id}~1acceptance/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/KycDocument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/postkycdocumentacceptance"}],"panels":[]}]},"httpPath":"/kyc-documents/{id}/acceptance"},{"label":"Update KYC document matches","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/postkycdocumentmatches","routeSlug":"/docs/dev-docs/api/kyc-documents/postkycdocumentmatches","metadata":{"seo":{"title":"Update KYC document matches","description":"Updates the document matches of a KYC document with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostKycDocumentMatches","name":"Update KYC document matches","isWebhook":false,"pointer":"/paths/~1kyc-documents~1{id}~1matches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update KYC document matches","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the document matches of a KYC document with a specified ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use this operation for manual overrides."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body schema depends on the KYC document "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation rejects unknown fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with one of:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchase-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funds-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified value identifies the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the document match."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1kyc-documents~1{id}~1matches/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_888"}},"schemaId":"schema_888","pointer":"/paths/~1kyc-documents~1{id}~1matches/post/requestBody","description":"KYC document matches overwrite payload."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/kyc-documents/{id}/matches","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_888"}},"responseCodes":["204","401","403","404","422","429"],"pointer":"/kyc-documents/{id}/matches","href":"kyc-documents/postkycdocumentmatches","openApiOperationId":"PostKycDocumentMatches","summary":"Update KYC document matches","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_888","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_888"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Document matches updated.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1kyc-documents~1{id}~1matches/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/postkycdocumentmatches"}],"panels":[]}]},"httpPath":"/kyc-documents/{id}/matches"},{"label":"Reject a KYC document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/postkycdocumentrejection","routeSlug":"/docs/dev-docs/api/kyc-documents/postkycdocumentrejection","metadata":{"seo":{"title":"Reject a KYC document","description":"Rejects a KYC document and changes the status to rejected.The review time and reviewer information is also updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostKycDocumentRejection","name":"Reject a KYC document","isWebhook":false,"pointer":"/paths/~1kyc-documents~1{id}~1rejection/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reject a KYC document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rejects a KYC document and changes the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The review time and reviewer information is also updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use this operation for manual overrides."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1kyc-documents~1{id}~1rejection/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KycDocumentRejection"}},"schemaId":"components/schemas/KycDocumentRejection","pointer":"/paths/~1kyc-documents~1{id}~1rejection/post/requestBody","description":"KYC document resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/kyc-documents/{id}/rejection","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/KycDocumentRejection"}},"responseCodes":["201","401","403","404","422","429"],"pointer":"/kyc-documents/{id}/rejection","href":"kyc-documents/postkycdocumentrejection","openApiOperationId":"PostKycDocumentRejection","summary":"Reject a KYC document","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const data = {\n type: 'document-expired',\n message: 'Document is expired'\n}\nconst rejectedDocument = await api.kycDocuments.reject({id: 'my-second-id', data});\nconsole.log(rejectedDocument.fields.rejectionReason.type);"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/KycDocumentRejection","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KycDocumentRejection"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"KYC document rejected.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}},"schemaId":"components/schemas/KycDocument","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1kyc-documents~1{id}~1rejection/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/KycDocument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/postkycdocumentrejection"}],"panels":[]}]},"httpPath":"/kyc-documents/{id}/rejection"},{"label":"Review a KYC document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/postkycdocumentreview","routeSlug":"/docs/dev-docs/api/kyc-documents/postkycdocumentreview","metadata":{"seo":{"title":"Review a KYC document","description":"Updates the reviewTime and reviewerId of a KYC document with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostKycDocumentReview","name":"Review a KYC document","isWebhook":false,"pointer":"/paths/~1kyc-documents~1{id}~1review/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Review a KYC document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a KYC document with a specified ID."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1kyc-documents~1{id}~1review/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/kyc-documents/{id}/review","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","401","403","404","422","429"],"pointer":"/kyc-documents/{id}/review","href":"kyc-documents/postkycdocumentreview","openApiOperationId":"PostKycDocumentReview","summary":"Review a KYC document","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const reviewedDocument = await api.kycDocuments.review({id: 'my-second-id'});\nconsole.log(reviewedDocument.fields.status);"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"KYC document reviewed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}},"schemaId":"components/schemas/KycDocument","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1kyc-documents~1{id}~1review/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/KycDocument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/postkycdocumentreview"}],"panels":[]}]},"httpPath":"/kyc-documents/{id}/review"},{"label":"Start review of a KYC document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/postkycdocumentstartreview","routeSlug":"/docs/dev-docs/api/kyc-documents/postkycdocumentstartreview","metadata":{"seo":{"title":"Start review of a KYC document","description":"Starts the review process of a KYC document with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostKycDocumentStartReview","name":"Start review of a KYC document","isWebhook":false,"pointer":"/paths/~1kyc-documents~1{id}~1start-review/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start review of a KYC document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts the review process of a KYC document with a specified ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation also sets the KYC document "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewStartTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the current date-time,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and updates the review information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1kyc-documents~1{id}~1start-review/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/kyc-documents/{id}/start-review","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","401","403","404","422","429"],"pointer":"/kyc-documents/{id}/start-review","href":"kyc-documents/postkycdocumentstartreview","openApiOperationId":"PostKycDocumentStartReview","summary":"Start review of a KYC document","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"KYC document review started.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}},"schemaId":"components/schemas/KycDocument","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1kyc-documents~1{id}~1start-review/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/KycDocument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/postkycdocumentstartreview"}],"panels":[]}]},"httpPath":"/kyc-documents/{id}/start-review"},{"label":"Stop review of a KYC document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/postkycdocumentstopreview","routeSlug":"/docs/dev-docs/api/kyc-documents/postkycdocumentstopreview","metadata":{"seo":{"title":"Stop review of a KYC document","description":"Stops the review of a KYC document with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostKycDocumentStopReview","name":"Stop review of a KYC document","isWebhook":false,"pointer":"/paths/~1kyc-documents~1{id}~1stop-review/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stop review of a KYC document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stops the review of a KYC document with a specified ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation also sets the KYC document "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewStartTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the reviewer information to null."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this operation when the reviewer must stop the review."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if the reviewer must take a break, or ends a shift."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1kyc-documents~1{id}~1stop-review/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/kyc-documents/{id}/stop-review","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","401","403","404","422","429"],"pointer":"/kyc-documents/{id}/stop-review","href":"kyc-documents/postkycdocumentstopreview","openApiOperationId":"PostKycDocumentStopReview","summary":"Stop review of a KYC document","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"KYC document review stopped.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}},"schemaId":"components/schemas/KycDocument","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1kyc-documents~1{id}~1stop-review/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/KycDocument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycDocument"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/postkycdocumentstopreview"}],"panels":[]}]},"httpPath":"/kyc-documents/{id}/stop-review"},{"label":"Retrieve KYC settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/getkycsettings","routeSlug":"/docs/dev-docs/api/kyc-documents/getkycsettings","metadata":{"seo":{"title":"Retrieve KYC settings","description":"Retrieves KYC settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetKycSettings","name":"Retrieve KYC settings","isWebhook":false,"pointer":"/paths/~1kyc-settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve KYC settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves KYC settings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/kyc-settings","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/kyc-settings","href":"kyc-documents/getkycsettings","openApiOperationId":"GetKycSettings","summary":"Retrieve KYC settings","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"KYC settings retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycSettings"}},"schemaId":"components/schemas/KycSettings"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1kyc-settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KycSettings","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycSettings"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/getkycsettings"}],"panels":[]}]},"httpPath":"/kyc-settings"},{"label":"Update KYC settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/kyc-documents/putkycsettings","routeSlug":"/docs/dev-docs/api/kyc-documents/putkycsettings","metadata":{"seo":{"title":"Update KYC settings","description":"Updates KYC settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutKycSettings","name":"Update KYC settings","isWebhook":false,"pointer":"/paths/~1kyc-settings/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update KYC settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates KYC settings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KycSettings"}},"schemaId":"components/schemas/KycSettings","pointer":"/paths/~1kyc-settings/put/requestBody","description":"Settings for KYC analysis."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/kyc-settings","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/KycSettings"}},"responseCodes":["200","401","403","404","429"],"pointer":"/kyc-settings","href":"kyc-documents/putkycsettings","openApiOperationId":"PutKycSettings","summary":"Update KYC settings","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/KycSettings","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KycSettings"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"KYC settings updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycSettings"}},"schemaId":"components/schemas/KycSettings","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1kyc-settings/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KycSettings","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycSettings"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/putkycsettings"}],"panels":[]}]},"httpPath":"/kyc-settings"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"KYC document accepted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-document-accepted","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-document-accepted","metadata":{"seo":{"title":"KYC document accepted","description":"KYC document accepted"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kyc-document-accepted","name":"KYC document accepted","isWebhook":true,"pointer":"/paths/kyc-document-accepted/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC document accepted","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_889"}},"schemaId":"schema_889","pointer":"/paths/kyc-document-accepted/post/requestBody","description":"Payload of KYC document-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"kyc-document-accepted","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_889"}},"responseCodes":["2xx"],"pointer":"kyc-document-accepted","href":"kyc-documents/kyc-document-accepted","openApiOperationId":"kyc-document-accepted","summary":"KYC document accepted","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_889","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_889"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/kyc-document-accepted/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/kyc-document-accepted"}],"panels":[]}]},"httpPath":"kyc-document-accepted"},{"label":"KYC document created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-document-created","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-document-created","metadata":{"seo":{"title":"KYC document created","description":"KYC document created"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kyc-document-created","name":"KYC document created","isWebhook":true,"pointer":"/paths/kyc-document-created/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC document created","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_889"}},"schemaId":"schema_889","pointer":"/paths/kyc-document-created/post/requestBody","description":"Payload of KYC document-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"kyc-document-created","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_889"}},"responseCodes":["2xx"],"pointer":"kyc-document-created","href":"kyc-documents/kyc-document-created","openApiOperationId":"kyc-document-created","summary":"KYC document created","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_889","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_889"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/kyc-document-created/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/kyc-document-created"}],"panels":[]}]},"httpPath":"kyc-document-created"},{"label":"KYC document modified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-document-modified","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-document-modified","metadata":{"seo":{"title":"KYC document modified","description":"KYC document modified"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kyc-document-modified","name":"KYC document modified","isWebhook":true,"pointer":"/paths/kyc-document-modified/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC document modified","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_889"}},"schemaId":"schema_889","pointer":"/paths/kyc-document-modified/post/requestBody","description":"Payload of KYC document-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"kyc-document-modified","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_889"}},"responseCodes":["2xx"],"pointer":"kyc-document-modified","href":"kyc-documents/kyc-document-modified","openApiOperationId":"kyc-document-modified","summary":"KYC document modified","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_889","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_889"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/kyc-document-modified/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/kyc-document-modified"}],"panels":[]}]},"httpPath":"kyc-document-modified"},{"label":"KYC document rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-document-rejected","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-document-rejected","metadata":{"seo":{"title":"KYC document rejected","description":"KYC document rejected"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kyc-document-rejected","name":"KYC document rejected","isWebhook":true,"pointer":"/paths/kyc-document-rejected/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC document rejected","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_889"}},"schemaId":"schema_889","pointer":"/paths/kyc-document-rejected/post/requestBody","description":"Payload of KYC document-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"kyc-document-rejected","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_889"}},"responseCodes":["2xx"],"pointer":"kyc-document-rejected","href":"kyc-documents/kyc-document-rejected","openApiOperationId":"kyc-document-rejected","summary":"KYC document rejected","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_889","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_889"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/kyc-document-rejected/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/kyc-document-rejected"}],"panels":[]}]},"httpPath":"kyc-document-rejected"},{"label":"KYC document reviewed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-document-reviewed","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-document-reviewed","metadata":{"seo":{"title":"KYC document reviewed","description":"KYC document reviewed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kyc-document-reviewed","name":"KYC document reviewed","isWebhook":true,"pointer":"/paths/kyc-document-reviewed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC document reviewed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_889"}},"schemaId":"schema_889","pointer":"/paths/kyc-document-reviewed/post/requestBody","description":"Payload of KYC document-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"kyc-document-reviewed","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_889"}},"responseCodes":["2xx"],"pointer":"kyc-document-reviewed","href":"kyc-documents/kyc-document-reviewed","openApiOperationId":"kyc-document-reviewed","summary":"KYC document reviewed","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_889","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_889"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/kyc-document-reviewed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/kyc-document-reviewed"}],"panels":[]}]},"httpPath":"kyc-document-reviewed"},{"label":"KYC document archived","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-document-archived","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-document-archived","metadata":{"seo":{"title":"KYC document archived","description":"KYC document archived"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kyc-document-archived","name":"KYC document archived","isWebhook":true,"pointer":"/paths/kyc-document-archived/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC document archived","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_889"}},"schemaId":"schema_889","pointer":"/paths/kyc-document-archived/post/requestBody","description":"Payload of KYC document-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"kyc-document-archived","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_889"}},"responseCodes":["2xx"],"pointer":"kyc-document-archived","href":"kyc-documents/kyc-document-archived","openApiOperationId":"kyc-document-archived","summary":"KYC document archived","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_889","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_889"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/kyc-document-archived/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/kyc-document-archived"}],"panels":[]}]},"httpPath":"kyc-document-archived"},{"label":"KYC request attempted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-request-attempted","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-request-attempted","metadata":{"seo":{"title":"KYC request attempted","description":"KYC request attempted"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kyc-request-attempted","name":"KYC request attempted","isWebhook":true,"pointer":"/paths/kyc-request-attempted/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC request attempted","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_890"}},"schemaId":"schema_890","pointer":"/paths/kyc-request-attempted/post/requestBody","description":"Payload of KYC request-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"kyc-request-attempted","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_890"}},"responseCodes":["2xx"],"pointer":"kyc-request-attempted","href":"kyc-documents/kyc-request-attempted","openApiOperationId":"kyc-request-attempted","summary":"KYC request attempted","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_890","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_890"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/kyc-request-attempted/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/kyc-request-attempted"}],"panels":[]}]},"httpPath":"kyc-request-attempted"},{"label":"KYC request failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-request-failed","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-request-failed","metadata":{"seo":{"title":"KYC request failed","description":"KYC request failed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kyc-request-failed","name":"KYC request failed","isWebhook":true,"pointer":"/paths/kyc-request-failed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC request failed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_890"}},"schemaId":"schema_890","pointer":"/paths/kyc-request-failed/post/requestBody","description":"Payload of KYC request-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"kyc-request-failed","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_890"}},"responseCodes":["2xx"],"pointer":"kyc-request-failed","href":"kyc-documents/kyc-request-failed","openApiOperationId":"kyc-request-failed","summary":"KYC request failed","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_890","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_890"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/kyc-request-failed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/kyc-request-failed"}],"panels":[]}]},"httpPath":"kyc-request-failed"},{"label":"KYC request fulfilled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-request-fulfilled","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-request-fulfilled","metadata":{"seo":{"title":"KYC request fulfilled","description":"KYC request fulfilled"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kyc-request-fulfilled","name":"KYC request fulfilled","isWebhook":true,"pointer":"/paths/kyc-request-fulfilled/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC request fulfilled","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_890"}},"schemaId":"schema_890","pointer":"/paths/kyc-request-fulfilled/post/requestBody","description":"Payload of KYC request-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"kyc-request-fulfilled","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_890"}},"responseCodes":["2xx"],"pointer":"kyc-request-fulfilled","href":"kyc-documents/kyc-request-fulfilled","openApiOperationId":"kyc-request-fulfilled","summary":"KYC request fulfilled","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_890","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_890"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/kyc-request-fulfilled/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/kyc-request-fulfilled"}],"panels":[]}]},"httpPath":"kyc-request-fulfilled"},{"label":"KYC request partially fulfilled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/kyc-documents/kyc-request-partially-fulfilled","routeSlug":"/docs/dev-docs/api/kyc-documents/kyc-request-partially-fulfilled","metadata":{"seo":{"title":"KYC request partially fulfilled","description":"KYC request partially fulfilled"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kyc-request-partially-fulfilled","name":"KYC request partially fulfilled","isWebhook":true,"pointer":"/paths/kyc-request-partially-fulfilled/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC request partially fulfilled","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_890"}},"schemaId":"schema_890","pointer":"/paths/kyc-request-partially-fulfilled/post/requestBody","description":"Payload of KYC request-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"kyc-request-partially-fulfilled","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_890"}},"responseCodes":["2xx"],"pointer":"kyc-request-partially-fulfilled","href":"kyc-documents/kyc-request-partially-fulfilled","openApiOperationId":"kyc-request-partially-fulfilled","summary":"KYC request partially fulfilled","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_890","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_890"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/kyc-request-partially-fulfilled/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-documents/kyc-request-partially-fulfilled"}],"panels":[]}]},"httpPath":"kyc-request-partially-fulfilled"}],"content":{"contentType":"group","meta":{"name":"KYC documents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC documents","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Know Your Customer (KYC) documents to verify your customers identity."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The KYC document operations generate a signed link to the Rebilly "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/kyc-and-aml/kyc-document-gatherer/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC document gatherer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Validates a customer's identity."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Validates a customer's address."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchase-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Validates a customer's purchase."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funds-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Validates that a customer has funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit-file-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Verifies that there is an existing credit file with two sources that match the customer's name, DOB, and address."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rebilly parses and analyzes the documents and accepts or rejects them according to a configurable scoring algorithm."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When all document types in a KYC request are accepted, the status is fulfilled, and the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/api/kyc-documents/kyc-request-fulfilled/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC request fulfilled webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is sent."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/kyc-requests","summary":"Create a KYC request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/postkycrequest","deprecated":false},{"title":"/kyc-requests","summary":"Retrieve KYC requests","prefix":{"name":"get","color":"get"},"badges":[],"link":"/kyc-documents/getkycrequestcollection","deprecated":false},{"title":"/kyc-requests/{id}","summary":"Retrieve a KYC request","prefix":{"name":"get","color":"get"},"badges":[],"link":"/kyc-documents/getkycrequest","deprecated":false},{"title":"/kyc-requests/{id}","summary":"Update a KYC request","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/kyc-documents/patchkycrequest","deprecated":false},{"title":"/kyc-requests/{id}","summary":"Delete the KYC request","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/kyc-documents/deletekycrequest","deprecated":false},{"title":"/kyc-documents","summary":"Retrieve KYC documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/kyc-documents/getkycdocumentcollection","deprecated":false},{"title":"/kyc-documents","summary":"Create a KYC document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/postkycdocument","deprecated":false},{"title":"/kyc-documents/{id}","summary":"Retrieve a KYC document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/kyc-documents/getkycdocument","deprecated":false},{"title":"/kyc-documents/{id}","summary":"Upsert a KYC document","prefix":{"name":"put","color":"put"},"badges":[],"link":"/kyc-documents/putkycdocument","deprecated":false},{"title":"/kyc-documents/{id}/acceptance","summary":"Accept a KYC document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/postkycdocumentacceptance","deprecated":false},{"title":"/kyc-documents/{id}/matches","summary":"Update KYC document matches","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/postkycdocumentmatches","deprecated":false},{"title":"/kyc-documents/{id}/rejection","summary":"Reject a KYC document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/postkycdocumentrejection","deprecated":false},{"title":"/kyc-documents/{id}/review","summary":"Review a KYC document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/postkycdocumentreview","deprecated":false},{"title":"/kyc-documents/{id}/start-review","summary":"Start review of a KYC document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/postkycdocumentstartreview","deprecated":false},{"title":"/kyc-documents/{id}/stop-review","summary":"Stop review of a KYC document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/postkycdocumentstopreview","deprecated":false},{"title":"/kyc-settings","summary":"Retrieve KYC settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/kyc-documents/getkycsettings","deprecated":false},{"title":"/kyc-settings","summary":"Update KYC settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/kyc-documents/putkycsettings","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"kyc-document-accepted","summary":"KYC document accepted","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/kyc-document-accepted","deprecated":false},{"title":"kyc-document-created","summary":"KYC document created","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/kyc-document-created","deprecated":false},{"title":"kyc-document-modified","summary":"KYC document modified","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/kyc-document-modified","deprecated":false},{"title":"kyc-document-rejected","summary":"KYC document rejected","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/kyc-document-rejected","deprecated":false},{"title":"kyc-document-reviewed","summary":"KYC document reviewed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/kyc-document-reviewed","deprecated":false},{"title":"kyc-document-archived","summary":"KYC document archived","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/kyc-document-archived","deprecated":false},{"title":"kyc-request-attempted","summary":"KYC request attempted","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/kyc-request-attempted","deprecated":false},{"title":"kyc-request-failed","summary":"KYC request failed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/kyc-request-failed","deprecated":false},{"title":"kyc-request-fulfilled","summary":"KYC request fulfilled","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/kyc-request-fulfilled","deprecated":false},{"title":"kyc-request-partially-fulfilled","summary":"KYC request partially fulfilled","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-documents/kyc-request-partially-fulfilled","deprecated":false}]}]}]}]}},{"type":"group","label":"AML","link":"/docs/dev-docs/api/aml","routeSlug":"/docs/dev-docs/api/aml","items":[{"label":"Retrieve AML checks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/aml/getamlcheckcollection","routeSlug":"/docs/dev-docs/api/aml/getamlcheckcollection","metadata":{"seo":{"title":"Retrieve AML checks","description":"Retrieves a list of AML checks. These checks are records of customer data and potentially matching data in AML lists."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetAmlCheckCollection","name":"Retrieve AML checks","isWebhook":false,"pointer":"/paths/~1aml-checks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve AML checks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of AML checks.\nThese checks are records of customer data and potentially matching data in AML lists."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."}],"pointer":"/paths/~1aml-checks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/aml-checks","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"q","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/aml-checks","href":"aml/getamlcheckcollection","openApiOperationId":"GetAmlCheckCollection","summary":"Retrieve AML checks","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of AML checks retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}},"schemaId":"schema_891","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1aml-checks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_891","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_891"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml/getamlcheckcollection"}],"panels":[]}]},"httpPath":"/aml-checks"},{"label":"Retrieve an AML check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/aml/getamlcheck","routeSlug":"/docs/dev-docs/api/aml/getamlcheck","metadata":{"seo":{"title":"Retrieve an AML check","description":"Retrieves the results of a customer's AML check. Customer metadata and an array of matching AML hits is returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetAmlCheck","name":"Retrieve an AML check","isWebhook":false,"pointer":"/paths/~1aml-checks~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an AML check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the results of a customer's AML check.\nCustomer metadata and an array of matching AML hits is returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1aml-checks~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/aml-checks/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/aml-checks/{id}","href":"aml/getamlcheck","openApiOperationId":"GetAmlCheck","summary":"Retrieve an AML check","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AML check retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AmlCheck"}},"schemaId":"components/schemas/AmlCheck"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1aml-checks~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AmlCheck","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AmlCheck"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml/getamlcheck"}],"panels":[]}]},"httpPath":"/aml-checks/{id}"},{"label":"Start review of an AML check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/aml/postamlcheckstartreview","routeSlug":"/docs/dev-docs/api/aml/postamlcheckstartreview","metadata":{"seo":{"title":"Start review of an AML check","description":"Starts the manual review process for an AML check with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostAmlCheckStartReview","name":"Start review of an AML check","isWebhook":false,"pointer":"/paths/~1aml-checks~1{id}~1start-review/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start review of an AML check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts the manual review process for an AML check with a specified ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation also sets the AML check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewStartTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the current date-time,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and updates the review information."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1aml-checks~1{id}~1start-review/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/aml-checks/{id}/start-review","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","401","403","404","422","429"],"pointer":"/aml-checks/{id}/start-review","href":"aml/postamlcheckstartreview","openApiOperationId":"PostAmlCheckStartReview","summary":"Start review of an AML check","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"AML check review started.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AmlCheck"}},"schemaId":"components/schemas/AmlCheck","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1aml-checks~1{id}~1start-review/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/AmlCheck","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AmlCheck"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml/postamlcheckstartreview"}],"panels":[]}]},"httpPath":"/aml-checks/{id}/start-review"},{"label":"Stop review of an AML check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/aml/postamlcheckstopreview","routeSlug":"/docs/dev-docs/api/aml/postamlcheckstopreview","metadata":{"seo":{"title":"Stop review of an AML check","description":"Stops the manual review process for an AML check with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostAmlCheckStopReview","name":"Stop review of an AML check","isWebhook":false,"pointer":"/paths/~1aml-checks~1{id}~1stop-review/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stop review of an AML check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stops the manual review process for an AML check with a specified ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation also sets the AML check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewStartTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the reviewer information to null."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this operation when the reviewer must stop the review."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if the reviewer must take a break, or ends a shift."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1aml-checks~1{id}~1stop-review/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/aml-checks/{id}/stop-review","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","401","403","404","422","429"],"pointer":"/aml-checks/{id}/stop-review","href":"aml/postamlcheckstopreview","openApiOperationId":"PostAmlCheckStopReview","summary":"Stop review of an AML check","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"AML document review stopped.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AmlCheck"}},"schemaId":"components/schemas/AmlCheck","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1aml-checks~1{id}~1stop-review/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/AmlCheck","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AmlCheck"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml/postamlcheckstopreview"}],"panels":[]}]},"httpPath":"/aml-checks/{id}/stop-review"},{"label":"Review an AML check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/aml/postamlcheckreview","routeSlug":"/docs/dev-docs/api/aml/postamlcheckreview","metadata":{"seo":{"title":"Review an AML check","description":"Reviews an AML check. The AML check can be either confirmed or marked as a false positive."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostAmlCheckReview","name":"Review an AML check","isWebhook":false,"pointer":"/paths/~1aml-checks~1{id}~1review/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Review an AML check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reviews an AML check.\nThe AML check can be either confirmed or marked as a false positive."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1aml-checks~1{id}~1review/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AmlCheckReview"}},"schemaId":"components/schemas/AmlCheckReview","pointer":"/paths/~1aml-checks~1{id}~1review/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/aml-checks/{id}/review","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AmlCheckReview"}},"responseCodes":["201","401","403","404","422","429"],"pointer":"/aml-checks/{id}/review","href":"aml/postamlcheckreview","openApiOperationId":"PostAmlCheckReview","summary":"Review an AML check","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/AmlCheckReview","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AmlCheckReview"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"AML check reviewed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AmlCheck"}},"schemaId":"components/schemas/AmlCheck","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1aml-checks~1{id}~1review/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/AmlCheck","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AmlCheck"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml/postamlcheckreview"}],"panels":[]}]},"httpPath":"/aml-checks/{id}/review"},{"label":"Retrieve AML settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/aml/getamlsettings","routeSlug":"/docs/dev-docs/api/aml/getamlsettings","metadata":{"seo":{"title":"Retrieve AML settings","description":"Retrieves AML settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetAmlSettings","name":"Retrieve AML settings","isWebhook":false,"pointer":"/paths/~1aml-settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve AML settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves AML settings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/aml-settings","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/aml-settings","href":"aml/getamlsettings","openApiOperationId":"GetAmlSettings","summary":"Retrieve AML settings","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AML settings retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AmlSettings"}},"schemaId":"components/schemas/AmlSettings"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1aml-settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AmlSettings","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AmlSettings"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml/getamlsettings"}],"panels":[]}]},"httpPath":"/aml-settings"},{"label":"Update AML settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/aml/putamlsettings","routeSlug":"/docs/dev-docs/api/aml/putamlsettings","metadata":{"seo":{"title":"Update AML settings","description":"Updates AML settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutAmlSettings","name":"Update AML settings","isWebhook":false,"pointer":"/paths/~1aml-settings/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update AML settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates AML settings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AmlSettings"}},"schemaId":"components/schemas/AmlSettings","pointer":"/paths/~1aml-settings/put/requestBody","description":"Settings for AML searches."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/aml-settings","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AmlSettings"}},"responseCodes":["200","201","401","403","404","429"],"pointer":"/aml-settings","href":"aml/putamlsettings","openApiOperationId":"PutAmlSettings","summary":"Update AML settings","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/AmlSettings","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AmlSettings"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AML settings updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AmlSettings"}},"schemaId":"components/schemas/AmlSettings","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"AML settings created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AmlSettings"}},"schemaId":"components/schemas/AmlSettings","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1aml-settings/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AmlSettings","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AmlSettings"}}},{"code":"201","schemaId":"components/schemas/AmlSettings","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AmlSettings"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml/putamlsettings"}],"panels":[]}]},"httpPath":"/aml-settings"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"AML list possibly matched","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/dev-docs/api/aml/aml-list-possibly-matched","routeSlug":"/docs/dev-docs/api/aml/aml-list-possibly-matched","metadata":{"seo":{"title":"AML list possibly matched","description":"AML list possibly matched"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"aml-list-possibly-matched","name":"AML list possibly matched","isWebhook":true,"pointer":"/paths/aml-list-possibly-matched/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AML list possibly matched","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_790"}},"schemaId":"schema_790","pointer":"/paths/aml-list-possibly-matched/post/requestBody","description":"Payload of customer-related webhook event."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"aml-list-possibly-matched","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_790"}},"responseCodes":["2xx"],"pointer":"aml-list-possibly-matched","href":"aml/aml-list-possibly-matched","openApiOperationId":"aml-list-possibly-matched","summary":"AML list possibly matched","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_790","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_790"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2xx","description":"Returns any 2xx status to indicate that data is received."}],"pointer":"/paths/aml-list-possibly-matched/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml/aml-list-possibly-matched"}],"panels":[]}]},"httpPath":"aml-list-possibly-matched"}],"content":{"contentType":"group","meta":{"name":"AML"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AML","showPageActions":true},{"nodeType":"markdoc","content":"Use Anti-Money Laundering (AML) operations to screen customers and help prevent your business from becoming directly or indirectly involved in criminal activity.\n\nUse AML operations during customer creation, and some transaction processing,\nto help determine if a potential customer (lead), or customer, has political or economic sanctions against them.\n\nAML operations search the following for screening purposes:\nPolitically Exposed Persons (PEPs) lists, sanction lists,\nand adverse media lists."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/aml-checks","summary":"Retrieve AML checks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml/getamlcheckcollection","deprecated":false},{"title":"/aml-checks/{id}","summary":"Retrieve an AML check","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml/getamlcheck","deprecated":false},{"title":"/aml-checks/{id}/start-review","summary":"Start review of an AML check","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aml/postamlcheckstartreview","deprecated":false},{"title":"/aml-checks/{id}/stop-review","summary":"Stop review of an AML check","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aml/postamlcheckstopreview","deprecated":false},{"title":"/aml-checks/{id}/review","summary":"Review an AML check","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aml/postamlcheckreview","deprecated":false},{"title":"/aml-settings","summary":"Retrieve AML settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml/getamlsettings","deprecated":false},{"title":"/aml-settings","summary":"Update AML settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/aml/putamlsettings","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"aml-list-possibly-matched","summary":"AML list possibly matched","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aml/aml-list-possibly-matched","deprecated":false}]}]}]}]}},{"type":"group","label":"Risk score","link":"/docs/dev-docs/api/risk-score","routeSlug":"/docs/dev-docs/api/risk-score","items":[{"label":"Retrieve risk score rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/risk-score/getriskscorerules","routeSlug":"/docs/dev-docs/api/risk-score/getriskscorerules","metadata":{"seo":{"title":"Retrieve risk score rules","description":"Retrieves risk score rules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetRiskScoreRules","name":"Retrieve risk score rules","isWebhook":false,"pointer":"/paths/~1risk-score-rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve risk score rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves risk score rules."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/risk-score-rules","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/risk-score-rules","href":"risk-score/getriskscorerules","openApiOperationId":"GetRiskScoreRules","summary":"Retrieve risk score rules","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Risk score rules retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiskScoreRules"}},"schemaId":"components/schemas/RiskScoreRules"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1risk-score-rules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RiskScoreRules","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiskScoreRules"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/risk-score/getriskscorerules"}],"panels":[]}]},"httpPath":"/risk-score-rules"},{"label":"Modify risk score rules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/risk-score/putriskscorerules","routeSlug":"/docs/dev-docs/api/risk-score/putriskscorerules","metadata":{"seo":{"title":"Modify risk score rules","description":"Modifies risk score rules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutRiskScoreRules","name":"Modify risk score rules","isWebhook":false,"pointer":"/paths/~1risk-score-rules/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify risk score rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Modifies risk score rules."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RiskScoreRules"}},"schemaId":"components/schemas/RiskScoreRules","pointer":"/paths/~1risk-score-rules/put/requestBody","description":"Risk score rules."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/risk-score-rules","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RiskScoreRules"}},"responseCodes":["200","201","401","403","422","429"],"pointer":"/risk-score-rules","href":"risk-score/putriskscorerules","openApiOperationId":"PutRiskScoreRules","summary":"Modify risk score rules","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/RiskScoreRules","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RiskScoreRules"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Risk score rules set.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiskScoreRules"}},"schemaId":"components/schemas/RiskScoreRules","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Risk score rules set.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiskScoreRules"}},"schemaId":"components/schemas/RiskScoreRules","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1risk-score-rules/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RiskScoreRules","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiskScoreRules"}}},{"code":"201","schemaId":"components/schemas/RiskScoreRules","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiskScoreRules"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/risk-score/putriskscorerules"}],"panels":[]}]},"httpPath":"/risk-score-rules"},{"label":"Retrieve risk score blocklist rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/risk-score/getriskscoreblocklistrules","routeSlug":"/docs/dev-docs/api/risk-score/getriskscoreblocklistrules","metadata":{"seo":{"title":"Retrieve risk score blocklist rules","description":"Retrieves risk score blocklist rules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetRiskScoreBlocklistRules","name":"Retrieve risk score blocklist rules","isWebhook":false,"pointer":"/paths/~1risk-score-rules~1blocklists/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve risk score blocklist rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves risk score blocklist rules."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/risk-score-rules/blocklists","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/risk-score-rules/blocklists","href":"risk-score/getriskscoreblocklistrules","openApiOperationId":"GetRiskScoreBlocklistRules","summary":"Retrieve risk score blocklist rules","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Risk score blocklist rules retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiskScoreBlocklist"}},"schemaId":"components/schemas/RiskScoreBlocklist"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1risk-score-rules~1blocklists/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RiskScoreBlocklist","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiskScoreBlocklist"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/risk-score/getriskscoreblocklistrules"}],"panels":[]}]},"httpPath":"/risk-score-rules/blocklists"},{"label":"Modify risk score blocklist rules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/risk-score/putriskscoreblocklistrules","routeSlug":"/docs/dev-docs/api/risk-score/putriskscoreblocklistrules","metadata":{"seo":{"title":"Modify risk score blocklist rules","description":"Modifies risk score blocklist rules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutRiskScoreBlocklistRules","name":"Modify risk score blocklist rules","isWebhook":false,"pointer":"/paths/~1risk-score-rules~1blocklists/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify risk score blocklist rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Modifies risk score blocklist rules."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RiskScoreBlocklist"}},"schemaId":"components/schemas/RiskScoreBlocklist","pointer":"/paths/~1risk-score-rules~1blocklists/put/requestBody","description":"Risk score blocklist rules."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/risk-score-rules/blocklists","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RiskScoreBlocklist"}},"responseCodes":["200","201","401","403","422","429"],"pointer":"/risk-score-rules/blocklists","href":"risk-score/putriskscoreblocklistrules","openApiOperationId":"PutRiskScoreBlocklistRules","summary":"Modify risk score blocklist rules","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/RiskScoreBlocklist","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RiskScoreBlocklist"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Risk score blocklist rules set.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiskScoreBlocklist"}},"schemaId":"components/schemas/RiskScoreBlocklist","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Risk score blocklist rules set.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiskScoreBlocklist"}},"schemaId":"components/schemas/RiskScoreBlocklist","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1risk-score-rules~1blocklists/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RiskScoreBlocklist","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiskScoreBlocklist"}}},{"code":"201","schemaId":"components/schemas/RiskScoreBlocklist","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiskScoreBlocklist"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/risk-score/putriskscoreblocklistrules"}],"panels":[]}]},"httpPath":"/risk-score-rules/blocklists"}],"content":{"contentType":"group","meta":{"name":"Risk score"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Risk score","showPageActions":true},{"nodeType":"markdoc","content":"Use risk score operations to configure blocklists based on transaction risk factors."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/risk-score-rules","summary":"Retrieve risk score rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/risk-score/getriskscorerules","deprecated":false},{"title":"/risk-score-rules","summary":"Modify risk score rules","prefix":{"name":"put","color":"put"},"badges":[],"link":"/risk-score/putriskscorerules","deprecated":false},{"title":"/risk-score-rules/blocklists","summary":"Retrieve risk score blocklist rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/risk-score/getriskscoreblocklistrules","deprecated":false},{"title":"/risk-score-rules/blocklists","summary":"Modify risk score blocklist rules","prefix":{"name":"put","color":"put"},"badges":[],"link":"/risk-score/putriskscoreblocklistrules","deprecated":false}]}]}]}]}},{"type":"separator","label":"Misc","content":null},{"type":"group","label":"Custom fields","link":"/docs/dev-docs/api/custom-fields","routeSlug":"/docs/dev-docs/api/custom-fields","items":[{"label":"Retrieve custom fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/custom-fields/getcustomfieldcollection","routeSlug":"/docs/dev-docs/api/custom-fields/getcustomfieldcollection","metadata":{"seo":{"title":"Retrieve custom fields","description":"Retrieves the custom fields schema for a specified resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCustomFieldCollection","name":"Retrieve custom fields","isWebhook":false,"pointer":"/paths/~1custom-fields~1{resource}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve custom fields","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the custom fields schema for a specified resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource","in":"path","schemaId":"schema_892","description":"Type of resource schema.","required":true}],"pointer":"/paths/~1custom-fields~1{resource}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."}],"pointer":"/paths/~1custom-fields~1{resource}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custom-fields/{resource}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"resource","in":"path","required":true,"schemaId":"schema_892"}],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/custom-fields/{resource}","href":"custom-fields/getcustomfieldcollection","openApiOperationId":"GetCustomFieldCollection","summary":"Retrieve custom fields","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$customFields = $client->customFields()->search('customers', [\n 'filter' => 'type:boolean',\n]);\n"},{"lang":"JavaScript","source":"// all parameters except `resource` are optional\nconst firstCollection = await api.customFields.getAll({resource: 'customers'});\n\n// alternatively you can specify one or more of them\nconst params = {resource: 'customers', limit: 20, offset: 100};\nconst secondCollection = await api.customFields.getAll(params);\n\n// access the collection items, each item is a CustomField\nsecondCollection.items.forEach(customField => console.log(customField.fields.description));\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$customFieldsPaginator = $service->customFields()->getAllPaginator(resource: 'customers', limit: 5);\nforeach ($customFieldsPaginator as $customFieldPage) {\n printf(\"Custom fields page %d/%d\\n\", $customFieldsPaginator->key() + 1, $customFieldsPaginator->count());\n foreach ($customFieldPage as $customField) {\n printf(\"Custom field #%s: %s\\n\", $customField->getName(), $customField->getDescription());\n }\n}\n\n// OR\n\n$customFields = $service->customFields()->getAll('customers');\nforeach ($customFields as $customField) {\n printf(\"Custom field #%s: %s\\n\", $customField->getName(), $customField->getDescription());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Schema of custom fields retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_893"}},"schemaId":"schema_893"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1custom-fields~1{resource}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_893","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_893"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-fields/getcustomfieldcollection"}],"panels":[]}]},"httpPath":"/custom-fields/{resource}"},{"label":"Retrieve a custom field","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/custom-fields/getcustomfield","routeSlug":"/docs/dev-docs/api/custom-fields/getcustomfield","metadata":{"seo":{"title":"Retrieve a custom field","description":"Retrieves a specified custom field schema for a specified resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCustomField","name":"Retrieve a custom field","isWebhook":false,"pointer":"/paths/~1custom-fields~1{resource}~1{name}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a custom field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a specified custom field schema for a specified resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource","in":"path","schemaId":"schema_892","description":"Type of resource schema.","required":true},{"name":"name","in":"path","schemaId":"schema_894","description":"ID of the custom field.","required":true}],"pointer":"/paths/~1custom-fields~1{resource}~1{name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custom-fields/{resource}/{name}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"resource","in":"path","required":true,"schemaId":"schema_892"},{"name":"name","in":"path","required":true,"schemaId":"schema_894"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/custom-fields/{resource}/{name}","href":"custom-fields/getcustomfield","openApiOperationId":"GetCustomField","summary":"Retrieve a custom field","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$customField = $client->customFields()->load('customers', 'testFieldName');\n"},{"lang":"JavaScript","source":"const customField = await api.customFields.get({resource: 'customers', name: 'dob'});\nconsole.log(customField.fields.description);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$customField = $service->customFields()->get('customers', 'testFieldName');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Custom field schema retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomField"}},"schemaId":"components/schemas/CustomField"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1custom-fields~1{resource}~1{name}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomField","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomField"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-fields/getcustomfield"}],"panels":[]}]},"httpPath":"/custom-fields/{resource}/{name}"},{"label":"Create or alter a custom field","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/custom-fields/putcustomfield","routeSlug":"/docs/dev-docs/api/custom-fields/putcustomfield","metadata":{"seo":{"title":"Create or alter a custom field","description":"Creates or alters a specified custom field schema for a specified resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutCustomField","name":"Create or alter a custom field","isWebhook":false,"pointer":"/paths/~1custom-fields~1{resource}~1{name}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or alter a custom field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates or alters a specified custom field schema for a specified resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource","in":"path","schemaId":"schema_892","description":"Type of resource schema.","required":true},{"name":"name","in":"path","schemaId":"schema_894","description":"ID of the custom field.","required":true}],"pointer":"/paths/~1custom-fields~1{resource}~1{name}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomField"}},"schemaId":"components/schemas/CustomField","pointer":"/paths/~1custom-fields~1{resource}~1{name}/put/requestBody","description":"Custom fields schema of the specified resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/custom-fields/{resource}/{name}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"resource","in":"path","required":true,"schemaId":"schema_892"},{"name":"name","in":"path","required":true,"schemaId":"schema_894"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomField"}},"responseCodes":["200","201","401","409","422","429"],"pointer":"/custom-fields/{resource}/{name}","href":"custom-fields/putcustomfield","openApiOperationId":"PutCustomField","summary":"Create or alter a custom field","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$customFieldForm = new Rebilly\\Entities\\CustomField();\n$customFieldForm->setType($customFieldForm::TYPE_BOOLEAN);\n\ntry {\n $customField = $client->customFields()->update('customers', 'testFieldName', $customFieldForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// creating a custom field\nconst data = {\n name: 'Date of Birth',\n type: 'date',\n description: `The customer's date of birth`\n};\n\n// define the entire payload\nconst params = {resource: 'customers', name: 'dob', data};\n\n// create the custom field\nconst customField = await api.customFields.create(params);\n\n// or update the custom field\nconst customField = await api.customFields.update(params);\nconsole.log(customField.fields.name);\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$customFieldForm = new \\Rebilly\\Sdk\\Model\\BooleanCustomField();\n$customFieldForm->setDescription('testFieldDescription');\n\ntry {\n $customField = $service->customFields()->create('customers', 'testFieldName', $customFieldForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/CustomField","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomField"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Custom field updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomField"}},"schemaId":"components/schemas/CustomField","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Custom field created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomField"}},"schemaId":"components/schemas/CustomField","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"409","description":"Schema in use. To remove or alter the schema, remove all\nassociated data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1custom-fields~1{resource}~1{name}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomField","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomField"}}},{"code":"201","schemaId":"components/schemas/CustomField","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomField"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"409","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-fields/putcustomfield"}],"panels":[]}]},"httpPath":"/custom-fields/{resource}/{name}"}],"content":{"contentType":"group","meta":{"name":"Custom fields"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom fields","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use custom fields to extend a resource scheme to include custom data that is not provided as a common field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the resource on which the custom field is added, it may be available in the Rebilly UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: A custom field called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"preferredCommunicationChannel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is added to the customer resource."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It has two allowed values, which are 'email' and 'phone'."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"customFields\": {\n \"preferredCommunicationChannel\": \"email\"\n }\n}\n","language":"js"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"customFields\": {\n \"preferredCommunicationChannel\": \"email\"\n }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For detailed information on Rebilly resources, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/concepts/#resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/custom-fields/{resource}","summary":"Retrieve custom fields","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-fields/getcustomfieldcollection","deprecated":false},{"title":"/custom-fields/{resource}/{name}","summary":"Retrieve a custom field","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-fields/getcustomfield","deprecated":false},{"title":"/custom-fields/{resource}/{name}","summary":"Create or alter a custom field","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-fields/putcustomfield","deprecated":false}]}]}]}]}},{"type":"group","label":"Files","link":"/docs/dev-docs/api/files","routeSlug":"/docs/dev-docs/api/files","items":[{"label":"Retrieve attachments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/getattachmentcollection","routeSlug":"/docs/dev-docs/api/files/getattachmentcollection","metadata":{"seo":{"title":"Retrieve attachments","description":"Retrieves a list of attachments. You may sort attachments by: id,name, relatedId, relatedType, fileId, createdTime,and updatedTime."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetAttachmentCollection","name":"Retrieve attachments","isWebhook":false,"pointer":"/paths/~1attachments/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve attachments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a list of attachments. You may sort attachments by: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relatedId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relatedType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."},{"name":"expand","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expands a request to include embedded objects within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property of the response. This field accepts a comma-separated list of objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/expand-embedded-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"fields","in":"query","schemaId":"schema_782","description":"Limits the returned fields to the specified list, each field separated by a comma.\nThe ID value is always returned."},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1attachments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/attachments","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"q","in":"query","schemaId":"schema_782"},{"name":"expand","in":"query","schemaId":"schema_782"},{"name":"fields","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/attachments","href":"files/getattachmentcollection","openApiOperationId":"GetAttachmentCollection","summary":"Retrieve attachments","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$attachments = $client->attachments()->search([\n 'filter' => 'relatedType:customer',\n]);\n"},{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.files.getAllAttachments();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100, sort: '-createdTime'};\nconst secondCollection = await api.files.getAllAttachments(params);\n\n// access the collection items, each item is an Attachment\nsecondCollection.items.forEach(attachment => console.log(attachment.fields.relatedType));\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$attachmentsPaginator = $service->files()->getAllAttachmentsPaginator(limit: 5, filter: 'relatedType:customer');\nforeach ($attachmentsPaginator as $attachmentPage) {\n printf(\"Attachments page %d/%d\\n\", $attachmentsPaginator->key() + 1, $attachmentsPaginator->count());\n foreach ($attachmentPage as $attachment) {\n printf(\"Attachment #%s (%s): %s\\n\", $attachment->getId(), $attachment->getRelatedType(), $attachment->getName());\n }\n}\n\n// OR\n\n$attachments = $service->files()->getAllAttachments(filter: 'relatedType:customer');\nforeach ($attachments as $attachment) {\n printf(\"Attachment #%s (%s): %s\\n\", $attachment->getId(), $attachment->getRelatedType(), $attachment->getName());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of attachments retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_895"}},"schemaId":"schema_895","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1attachments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_895","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_895"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/getattachmentcollection"}],"panels":[]}]},"httpPath":"/attachments"},{"label":"Create an attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/postattachment","routeSlug":"/docs/dev-docs/api/files/postattachment","metadata":{"seo":{"title":"Create an attachment","description":"Attaches a file to one or multiple objects, such as: customer, dispute, transaction, order, plan, product, invoice, or timeline comment. Attachments enable you to quickly find and use files related to specific entities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostAttachment","name":"Create an attachment","isWebhook":false,"pointer":"/paths/~1attachments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Attaches a file to one or multiple objects, such as: customer,\ndispute, transaction, order, plan, product, invoice, or timeline\ncomment. Attachments enable you to quickly find and use files\nrelated to specific entities."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Attachment"}},"schemaId":"components/schemas/Attachment","pointer":"/paths/~1attachments/post/requestBody","description":"Attachment resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/attachments","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Attachment"}},"responseCodes":["201","401","403","409","422","429"],"pointer":"/attachments","href":"files/postattachment","openApiOperationId":"PostAttachment","summary":"Create an attachment","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$attachmentForm = new Rebilly\\Entities\\Attachment();\n$attachmentForm->setFileId('fileId');\n$attachmentForm->setRelatedType($attachmentForm::TYPE_CUSTOMER);\n$attachmentForm->setRelatedId('customerId');\n\ntry {\n $attachment = $client->attachments()->create($attachmentForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// Define the attachment\nconst data = {\n // Previously uploaded file ID\n fileId: 'my-file-id',\n relatedType: 'customer',\n relatedId: 'my-customer-id',\n name: 'an attachment',\n description: `the customer's file`\n};\n\nconst attachment = await api.files.attach({data});\nconsole.log(attachment.fields.id);\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$attachmentForm = new \\Rebilly\\Sdk\\Model\\Attachment();\n$attachmentForm->setFileId('fileId');\n$attachmentForm->setRelatedType($attachmentForm::RELATED_TYPE_CUSTOMER);\n$attachmentForm->setRelatedId('customerId');\n\ntry {\n $attachment = $service->files()->attach($attachmentForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Attachment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Attachment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Attachment created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Attachment"}},"schemaId":"components/schemas/Attachment","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1attachments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Attachment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Attachment"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/postattachment"}],"panels":[]}]},"httpPath":"/attachments"},{"label":"Retrieve an attachment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/getattachment","routeSlug":"/docs/dev-docs/api/files/getattachment","metadata":{"seo":{"title":"Retrieve an attachment","description":"Retrieves an attachment with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetAttachment","name":"Retrieve an attachment","isWebhook":false,"pointer":"/paths/~1attachments~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an attachment with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1attachments~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/attachments/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/attachments/{id}","href":"files/getattachment","openApiOperationId":"GetAttachment","summary":"Retrieve an attachment","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$attachment = $client->attachments()->load('attachmentId');\n"},{"lang":"JavaScript","source":"const attachment = await api.files.getAttachment({id: 'foobar-001'});\nconsole.log(attachment.fields.relatedType);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$attachment = $service->files()->getAttachment('attachmentId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Attachment"}},"schemaId":"components/schemas/Attachment"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1attachments~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Attachment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Attachment"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/getattachment"}],"panels":[]}]},"httpPath":"/attachments/{id}"},{"label":"Update an attachment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/putattachment","routeSlug":"/docs/dev-docs/api/files/putattachment","metadata":{"seo":{"title":"Update an attachment","description":"Updates an attachment with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutAttachment","name":"Update an attachment","isWebhook":false,"pointer":"/paths/~1attachments~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an attachment with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1attachments~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Attachment"}},"schemaId":"components/schemas/Attachment","pointer":"/paths/~1attachments~1{id}/put/requestBody","description":"Attachment resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/attachments/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Attachment"}},"responseCodes":["200","201","401","403","404","409","422","429"],"pointer":"/attachments/{id}","href":"files/putattachment","openApiOperationId":"PutAttachment","summary":"Update an attachment","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$attachmentForm = new Rebilly\\Entities\\Attachment();\n$attachmentForm->setFileId('fileId');\n$attachmentForm->setRelatedType($attachmentForm::TYPE_CUSTOMER);\n$attachmentForm->setRelatedId('customerId');\n\ntry {\n $attachment = $client->attachments()->update('attachmentId', $attachmentForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// define the values to update\nconst data = {\n relatedType: 'customer',\n relatedId: 'my-customer-id',\n name: 'an attachment',\n description: `the customer's file`\n};\n\nconst attachment = await api.files.updateAttachment({id: 'foobar-001', data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$attachmentForm = new \\Rebilly\\Sdk\\Model\\Attachment();\n$attachmentForm->setFileId('fileId');\n$attachmentForm->setRelatedType($attachmentForm::RELATED_TYPE_CUSTOMER);\n$attachmentForm->setRelatedId('customerId');\n\ntry {\n $attachment = $service->files()->updateAttachment('attachmentId', $attachmentForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/Attachment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Attachment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Attachment"}},"schemaId":"components/schemas/Attachment","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"201","description":"Attachment created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Attachment"}},"schemaId":"components/schemas/Attachment","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1attachments~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Attachment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Attachment"}}},{"code":"201","schemaId":"components/schemas/Attachment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Attachment"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/putattachment"}],"panels":[]}]},"httpPath":"/attachments/{id}"},{"label":"Delete an attachment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/deleteattachment","routeSlug":"/docs/dev-docs/api/files/deleteattachment","metadata":{"seo":{"title":"Delete an attachment","description":"Deletes an attachment with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteAttachment","name":"Delete an attachment","isWebhook":false,"pointer":"/paths/~1attachments~1{id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an attachment with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1attachments~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/attachments/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","404","429"],"pointer":"/attachments/{id}","href":"files/deleteattachment","openApiOperationId":"DeleteAttachment","summary":"Delete an attachment","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$client->attachments()->delete('attachmentId');\n"},{"lang":"JavaScript","source":"const request = await api.files.detach({id: 'my-attachment-id'});\n\n// the request does not return any fields but\n// you can confirm the success using the status code\nconsole.log(request.response.status); // 204"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$service->files()->detach('attachmentId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Attachment deleted."},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1attachments~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/deleteattachment"}],"panels":[]}]},"httpPath":"/attachments/{id}"},{"label":"Retrieve files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/getfilecollection","routeSlug":"/docs/dev-docs/api/files/getfilecollection","metadata":{"seo":{"title":"Retrieve files","description":"Retrieves a list of files."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetFileCollection","name":"Retrieve files","isWebhook":false,"pointer":"/paths/~1files/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve files","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of files."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"filter","in":"query","schemaId":"schema_782","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for filtering collection items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_782","description":"Use this field to perform a partial search of text fields."},{"name":"fields","in":"query","schemaId":"schema_782","description":"Limits the returned fields to the specified list, each field separated by a comma.\nThe ID value is always returned."},{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1files/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/files","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"filter","in":"query","schemaId":"schema_782"},{"name":"q","in":"query","schemaId":"schema_782"},{"name":"fields","in":"query","schemaId":"schema_782"},{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/files","href":"files/getfilecollection","openApiOperationId":"GetFileCollection","summary":"Retrieve files","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$files = $client->files()->search([\n 'filter' => 'name:TestFile',\n]);\n"},{"lang":"JavaScript","source":"// all parameters are optional\nconst firstCollection = await api.files.getAll();\n\n// alternatively you can specify one or more of them\nconst params = {limit: 20, offset: 100, sort: '-createdTime'};\nconst secondCollection = await api.files.getAll(params);\n\n// access the collection items, each item is a File\nsecondCollection.items.forEach(file => console.log(file.fields.name));\n"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$filesPaginator = $service->files()->getAllPaginator(limit: 5, filter: 'name:TestFile');\nforeach ($filesPaginator as $filesPage) {\n printf(\"Files page %d/%d\\n\", $filesPaginator->key() + 1, $filesPaginator->count());\n foreach ($filesPage as $file) {\n printf(\"File #%s: %s\\n\", $file->getId(), $file->getName());\n }\n}\n\n// OR\n\n$files = $service->files()->getAll(filter: 'name:TestFile');\nforeach ($files as $file) {\n printf(\"File #%s: %s\\n\", $file->getId(), $file->getName());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of files retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_896"}},"schemaId":"schema_896","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1files/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_896","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_896"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/getfilecollection"}],"panels":[]}]},"httpPath":"/files"},{"label":"Create a file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/postfile","routeSlug":"/docs/dev-docs/api/files/postfile","metadata":{"seo":{"title":"Create a file","description":"Creates a file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostFile","name":"Create a file","isWebhook":false,"pointer":"/paths/~1files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additionally, a file can be sent by:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multipart/form-data POST request: In this request,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the file is uploaded and all property names are the same as the JSON names."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File body request: In this request,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the file body is sent as the request body, with the appropriate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No additional properties can be set with the request data."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permitted file types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".gif"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using a publishable API key, only private files can be created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The files can be modified at a later point or time,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or can be accessed using a secret API key."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"PublishableApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This authentication method is applicable to specific operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a publishable API key, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/api-keys/postapikey"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an API key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_897"}},"schemaId":"schema_897","pointer":"/paths/~1files/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/files","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PublishableApiKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_897"}},"responseCodes":["201","401","403","422","429"],"pointer":"/files","href":"files/postfile","openApiOperationId":"PostFile","summary":"Create a file","securityGroups":[{"SecretApiKey":[]},{"JWT":[]},{"PublishableApiKey":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$fileForm = new Rebilly\\Entities\\File();\n$fileForm->setUrl('http://test.com/somefile.jpg');\n\ntry {\n $file = $client->files()->create($fileForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// using a FileList to fetch a file\nconst fileObject = fileList[0];\n\nconst addedFile = await api.files.upload({fileObject});\n\n\n\n\n// or, upload and update a file at the same time\n\n// using a FileList to fetch a file\nconst fileObject = fileList[0];\n\n// define file data\nconst data = {\n description: 'my new file',\n tags: ['original']\n};\n\nconst addedFile = await api.files.uploadAndUpdate({fileObject, data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n\n$fileForm = new \\Rebilly\\Sdk\\Model\\FileCreateFromUrl();\n$fileForm->setUrl('http://test.com/somefile.jpg');\n\ntry {\n $file = $service->files()->upload($fileForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"schema_897","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_897"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"File created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/File"}},"schemaId":"components/schemas/File","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_786"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1files/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/File","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/File"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/postfile"}],"panels":[]}]},"httpPath":"/files"},{"label":"Retrieve a file record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/getfile","routeSlug":"/docs/dev-docs/api/files/getfile","metadata":{"seo":{"title":"Retrieve a file record","description":"Retrieves a file with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetFile","name":"Retrieve a file record","isWebhook":false,"pointer":"/paths/~1files~1{id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a file record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a file with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1files~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/files/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/files/{id}","href":"files/getfile","openApiOperationId":"GetFile","summary":"Retrieve a file record","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$file = $client->files()->load('fileId');\n"},{"lang":"JavaScript","source":"const file = await api.files.get({id: 'foobar-001'});\nconsole.log(file.fields.name);"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$file = $service->files()->get('fileId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"File retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/File"}},"schemaId":"components/schemas/File"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1files~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/File","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/File"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/getfile"}],"panels":[]}]},"httpPath":"/files/{id}"},{"label":"Update a file","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/putfile","routeSlug":"/docs/dev-docs/api/files/putfile","metadata":{"seo":{"title":"Update a file","description":"Updates a file with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutFile","name":"Update a file","isWebhook":false,"pointer":"/paths/~1files~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a file with a specified ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Files can only be uploaded by POST request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the Create a file operation."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1files~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/File"}},"schemaId":"components/schemas/File","pointer":"/paths/~1files~1{id}/put/requestBody","description":"File resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/files/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/File"}},"responseCodes":["200","401","403","404","422","429"],"pointer":"/files/{id}","href":"files/putfile","openApiOperationId":"PutFile","summary":"Update a file","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$fileForm = new Rebilly\\Entities\\File();\n$fileForm->setDescription('This is a test file');\n\ntry {\n $file = $client->files()->update('fileId', $fileForm);\n} catch (Rebilly\\Http\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}\n"},{"lang":"JavaScript","source":"// define the values to update\nconst data = {\n name: 'new file name',\n description: 'a fitting description',\n tags: ['original']\n};\n\nconst file = await api.files.update({id: 'my-file-id', data});\n\n\n\n\n// or, upload and update a file at the same time\n\n// using a FileList to fetch a file\nconst fileObject = fileList[0];\n\n// define file data\nconst data = {\n description: 'my new file',\n tags: ['original']\n};\n\nconst addedFile = await api.files.uploadAndUpdate({fileObject, data});"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$fileForm = new \\Rebilly\\Sdk\\Model\\File();\n$fileForm->setDescription('This is a test file');\n\ntry {\n $file = $service->files()->update('fileId', $fileForm);\n} catch (\\Rebilly\\Sdk\\Exception\\DataValidationException $e) {\n print_r($e->getValidationErrors());\n}"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"schemaId":"components/schemas/File","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/File"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"File updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/File"}},"schemaId":"components/schemas/File","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"422","description":"Invalid data sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1files~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/File","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/File"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/putfile"}],"panels":[]}]},"httpPath":"/files/{id}"},{"label":"Delete a file","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/deletefile","routeSlug":"/docs/dev-docs/api/files/deletefile","metadata":{"seo":{"title":"Delete a file","description":"Deletes a file with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteFile","name":"Delete a file","isWebhook":false,"pointer":"/paths/~1files~1{id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a file with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1files~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/files/{id}","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","429"],"pointer":"/files/{id}","href":"files/deletefile","openApiOperationId":"DeleteFile","summary":"Delete a file","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"PHP","label":"PHP-SDK-2.0","source":"$client->files()->delete('fileId');\n"},{"lang":"JavaScript","source":"// simply delete a file\nconst request = await api.files.delete({id: 'my-file-id'});\n\n// the request does not return any fields but\n// you can confirm the success using the status code\nconsole.log(request.response.status); // 204\n\n\n\n\n// or, delete a file and its related resource attachments\n// use this method to remove the file completely from all resources at once.\n\nconst request = await api.files.detachAndDelete({id: 'my-file-id'});\n\n// the request does not return any fields but\n// you can confirm the success using the status code\nconsole.log(request.response.status); // 204"},{"lang":"PHP","source":"$service = new \\Rebilly\\Sdk\\Service($client);\n$service->files()->delete('fileId');"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"File deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"headerSchemaId":"schema_789"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"429","description":"Request rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}},"schemaId":"components/schemas/TooManyRequests","headers":{"X-RateLimit-Retry-After":{"$ref":"#/components/headers/X-RateLimit-Retry-After"}},"headerSchemaId":"schema_787"}],"pointer":"/paths/~1files~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"429","schemaId":"components/schemas/TooManyRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/deletefile"}],"panels":[]}]},"httpPath":"/files/{id}"},{"label":"Download a file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/files/getfiledownload","routeSlug":"/docs/dev-docs/api/files/getfiledownload","metadata":{"seo":{"title":"Download a file","description":"Downloads a file with a specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetFileDownload","name":"Download a file","isWebhook":false,"pointer":"/paths/~1files~1{id}~1download/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Downloads a file with a specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_788","description":"ID of the resource.","required":true}],"pointer":"/paths/~1files~1{id}~1download/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"imageSize","in":"query","schemaId":"schema_898","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resize image to specified size."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports any sizes from 10x10 to 2000x2000, in the following format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{width}x{height}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value is invalid, the image returns the original size."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter is ignored for non-image files."},"children":[]}]}]}]}],"pointer":"/paths/~1files~1{id}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/files/{id}/download","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_788"}],"query":[{"name":"imageSize","in":"query","example":"700x700","schemaId":"schema_898"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","302","401","403","404"],"pointer":"/files/{id}/download","href":"files/getfiledownload","openApiOperationId":"GetFileDownload","summary":"Download a file","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"definitionSamples":[{"lang":"JavaScript","source":"const file = await api.files.download({id: 'my-file-id'});\n\n// access the file ArrayBuffer to view the content \nconsole.log(file.data);"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"File retrieved.","mediaType":"application/json","mediaTypes":["application/json","application/pdf","application/zip","image/jpg","image/png","image/gif","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"schema_899"},"application/pdf":{"schemaId":"schema_899"},"application/zip":{"schemaId":"schema_899"},"image/jpg":{"schemaId":"schema_899"},"image/png":{"schemaId":"schema_899"},"image/gif":{"schemaId":"schema_899"},"text/csv":{"schemaId":"schema_899"}},"schemaId":"schema_899","headers":{"Content-Length":{"description":"Number of bytes in the file.","schema":{"type":"integer"},"example":48},"Content-Type":{"description":"MIME type of the file.","schema":{"type":"string"},"example":"image/png"}},"headerSchemaId":"schema_900"},{"code":"302","description":"Resource moved.","headers":{"Location":{"schema":{"type":"string","format":"uri"},"example":"https://api.rebilly.com/example"}},"headerSchemaId":"schema_901"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"}],"pointer":"/paths/~1files~1{id}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_899","mediaTypes":["application/json","application/pdf","application/zip","image/jpg","image/png","image/gif","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"schema_899"},"application/pdf":{"schemaId":"schema_899"},"application/zip":{"schemaId":"schema_899"},"image/jpg":{"schemaId":"schema_899"},"image/png":{"schemaId":"schema_899"},"image/gif":{"schemaId":"schema_899"},"text/csv":{"schemaId":"schema_899"}}},{"code":"302"},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/getfiledownload"}],"panels":[]}]},"httpPath":"/files/{id}/download"}],"content":{"contentType":"group","meta":{"name":"Files"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Files","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the file entity to store files and related metadata."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files can be sorted by size, MIME-type, user-defined tags, and description."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following methods are available to upload files:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multipart/form-data encoded form, RAW POST —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by sending the file contents as the POST body, and fetching from URL —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by providing the file URL using the 'url' parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the attachments entity to link a file to one or multiple objects, such as:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer, dispute, transaction, order, plan, product, invoice, or timeline comment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attachments enable you to quickly find and use files related to specific entities."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/attachments","summary":"Retrieve attachments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/getattachmentcollection","deprecated":false},{"title":"/attachments","summary":"Create an attachment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/files/postattachment","deprecated":false},{"title":"/attachments/{id}","summary":"Retrieve an attachment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/getattachment","deprecated":false},{"title":"/attachments/{id}","summary":"Update an attachment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/files/putattachment","deprecated":false},{"title":"/attachments/{id}","summary":"Delete an attachment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/files/deleteattachment","deprecated":false},{"title":"/files","summary":"Retrieve files","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/getfilecollection","deprecated":false},{"title":"/files","summary":"Create a file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/files/postfile","deprecated":false},{"title":"/files/{id}","summary":"Retrieve a file record","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/getfile","deprecated":false},{"title":"/files/{id}","summary":"Update a file","prefix":{"name":"put","color":"put"},"badges":[],"link":"/files/putfile","deprecated":false},{"title":"/files/{id}","summary":"Delete a file","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/files/deletefile","deprecated":false},{"title":"/files/{id}/download","summary":"Download a file","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/getfiledownload","deprecated":false}]}]}]}]}},{"type":"group","label":"Search","link":"/docs/dev-docs/api/search","routeSlug":"/docs/dev-docs/api/search","items":[{"label":"Search merchant data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/dev-docs/api/search/getsearch","routeSlug":"/docs/dev-docs/api/search/getsearch","metadata":{"seo":{"title":"Search merchant data","description":"Searches merchant data to return resources such as customers, invoices, orders, transactions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetSearch","name":"Search merchant data","isWebhook":false,"pointer":"/paths/~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search merchant data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches merchant data to return resources such as customers, invoices, orders, transactions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"SecretApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"REB-APIKEY","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header."}]},{"schemes":[{"name":"JWT","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_783","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts and orders the collection of items. To sort in descending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Multiple fields can be sorted by separating each with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_781","description":"Limits the number of collection items to be returned."},{"name":"offset","in":"query","schemaId":"schema_781","description":"Specifies the starting point within the collection of items to be returned."},{"name":"q","in":"query","schemaId":"schema_782","description":"Default search.\nSearches across resources and fields."}],"pointer":"/paths/~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/search","servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"parameters":{"path":[],"query":[{"name":"sort","in":"query","schemaId":"schema_783","style":"form","explode":false},{"name":"limit","in":"query","schemaId":"schema_781"},{"name":"offset","in":"query","schemaId":"schema_781"},{"name":"q","in":"query","schemaId":"schema_782"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SecretApiKey","type":"apiKey","name":"REB-APIKEY","in":"header"}],"scopes":[]},{"schemes":[{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/search","href":"search/getsearch","openApiOperationId":"GetSearch","summary":"Search merchant data","securityGroups":[{"SecretApiKey":[]},{"JWT":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/dev-docs/api","description":"Mock server","isMockServer":true},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}"}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Results keyed by a resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_902"}},"schemaId":"schema_902","headers":{"Pagination-Total":{"$ref":"#/components/headers/Pagination-Total"},"Pagination-Limit":{"$ref":"#/components/headers/Pagination-Limit"},"Pagination-Offset":{"$ref":"#/components/headers/Pagination-Offset"}},"headerSchemaId":"schema_785"},{"code":"401","description":"Unauthorized access.\nInvalid credentials used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Access forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1search/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_902","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_902"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search/getsearch"}],"panels":[]}]},"httpPath":"/search"}],"content":{"contentType":"group","meta":{"name":"Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search","showPageActions":true},{"nodeType":"markdoc","content":"Use search operations to search data on customers, invoices, orders, transactions and more."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/search","summary":"Search merchant data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search/getsearch","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/RegistrationFieldStep":{"id":"components/schemas/RegistrationFieldStep","kind":"json-schema","title":"RegistrationFieldStep","data":{"type":"object","required":["id","displayHeader"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the registration step."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value must start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" followed by lowercase alphanumeric characters or hyphens."},"children":[]}]}]}],"pattern":"^step-[a-z0-9-]+$","example":"step-0"},"displayHeader":{"type":"string","description":"Display header of the registration step.","minLength":1,"maxLength":255,"example":"Contact information"}}}},"components/schemas/RegistrationField":{"id":"components/schemas/RegistrationField","kind":"json-schema","title":"RegistrationField","data":{"type":"object","required":["attribute","displayName","requirementLevel","validationType","order","step"],"properties":{"attribute":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute of the Keycloak user profile."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value determines which user attribute the field maps to."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contentBlock"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute for static text in the registration form that requires no user input."},"children":[]}]}]}],"enum":["username","firstName","lastName","email","gender","dateOfBirth","addressLine1","addressLine2","city","postalCode","country","province","currency","mobileNumber","industry","occupation","marketingOptIn","termsAccepted","passwordStep","contentBlock"],"example":"email"},"displayName":{"type":"string","description":"Display name of the registration field.","minLength":1,"maxLength":255,"example":"Email Address"},"requirementLevel":{"type":"string","description":"Requirement level of the field.\nThis value determines whether the field is required, optional, or hidden during registration.","enum":["required","optional","hidden"],"default":"required","example":"required"},"validationType":{"type":"string","description":"Type of validation applied to the field input.","enum":["none","email","phone","alphanumeric","numeric","date","url","regex","password"],"default":"none","example":"email"},"validationPattern":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom validation regex pattern for the field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validationType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255},"minLength":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum length of the field value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not applicable when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfBirth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contentBlock"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minimum":0,"example":1},"maxLength":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum length of the field value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not applicable when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfBirth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contentBlock"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minimum":1,"example":255},"helpText":{"type":["string","null"],"description":"Help text displayed to the user for the field.","maxLength":500,"example":"Enter your email address"},"minimumAge":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum age in years for the registrant, calculated from their date of birth."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only applicable when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfBirth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minimum":1,"maximum":100,"example":19},"inputType":{"type":["string","null"],"description":"Type of input control for the field in the registration form.","enum":["text","select","checkbox","date",null],"example":"text"},"placeholder":{"type":["string","null"],"description":"Placeholder text displayed in the input field before the user enters a value.","maxLength":255,"example":"Enter your email address"},"contentBlock":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Static informational text in the registration form."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only applicable when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attribute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contentBlock"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":2048,"example":"For problem gaming assistance call 1-111-111-1111."},"order":{"type":"integer","description":"Display order of the field within a registration step.","minimum":0,"default":0,"example":0},"step":{"description":"Registration step associated with the field.","$ref":"#/components/schemas/RegistrationFieldStep"}}}},"components/schemas/CreatedTime":{"id":"components/schemas/CreatedTime","kind":"json-schema","title":"CreatedTime","data":{"type":"string","description":"Date and time when the resource is created.\nThis value is set automatically when the resource is created.","format":"date-time","readOnly":true,"x-sortable":true,"x-label":"Creation Time"}},"components/schemas/UpdatedTime":{"id":"components/schemas/UpdatedTime","kind":"json-schema","title":"UpdatedTime","data":{"type":"string","description":"Date and time when the resource is updated.\nThis value is set automatically when the resource is updated.","format":"date-time","readOnly":true,"x-sortable":true,"x-label":"Last Update Time"}},"components/schemas/SelfLink":{"id":"components/schemas/SelfLink","kind":"json-schema","title":"SelfLink","data":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self"]}}}}},"components/schemas/AccountRegistrationSettings":{"id":"components/schemas/AccountRegistrationSettings","kind":"json-schema","title":"AccountRegistrationSettings","data":{"type":"object","description":"Account registration settings define the fields, steps, and validation rules\nfor a customer registration flow.\nEach account registration settings resource is scoped to a set of locations\nand is synchronized with a Keycloak realm.","required":["name"],"properties":{"id":{"type":"string","description":"ID of the account registration settings.\nIf not provided, the ID is generated from the name.","maxLength":50,"pattern":"^[a-z0-9\\-]+$","example":"eu-registration"},"name":{"type":"string","description":"Name of the account registration settings.","minLength":1,"maxLength":255,"example":"EU Registration Requirements"},"description":{"type":["string","null"],"description":"Description of the account registration settings.","maxLength":1000,"example":"Account registration settings for EU customers"},"isEnabled":{"type":"boolean","description":"Specifies if the account registration settings are active.","default":true,"example":true},"locations":{"type":"array","description":"List of locations that the account registration settings apply to.\nEach location consists of a country and an optional region.","items":{"type":"object","required":["country"],"properties":{"country":{"type":"string","description":"Country code of the location.\nUse ISO 3166-1 alpha-2 country codes.","example":"CA"},"region":{"type":"string","description":"Region code of the location within the country.\nUse ISO 3166-2 subdivision codes without the country prefix.","example":"ON"}}},"example":[{"country":"CA","region":"ON"},{"country":"GB"}]},"fields":{"type":"array","description":"List of registration fields that define the registration form.","items":{"$ref":"#/components/schemas/RegistrationField"}},"realm":{"type":["string","null"],"description":"Keycloak realm associated with the account registration settings.","readOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/BaseProblem":{"id":"components/schemas/BaseProblem","kind":"json-schema","title":"BaseProblem","data":{"type":"object","additionalProperties":true,"minProperties":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC-7807 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7807"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"problem details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" JSON object."},"children":[]}]}]}],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Problem type in the form of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc3986"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reference."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It should provide human-readable documentation for the problem type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this member is not present, its value is assumed to be \"about:blank\"."},"children":[]}]}]}],"format":"uri"},"title":{"type":"string","description":"Short, human-readable summary of the problem type.\nOther than for the purposes of localization, this should not change from occurrence to occurrence of the problem."},"detail":{"type":"string","description":"Human-readable explanation that is specific to this occurrence of the problem."},"instance":{"type":"string","description":"URI reference that identifies the specific occurrence of the problem.\nIt may or may not yield further information if dereferenced."}}}},"components/schemas/Unauthorized":{"id":"components/schemas/Unauthorized","kind":"json-schema","title":"Unauthorized","data":{"allOf":[{"title":"Unauthorized"},{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code.","minimum":401,"maximum":401}}},{"$ref":"#/components/schemas/BaseProblem"}]}},"components/schemas/Forbidden":{"id":"components/schemas/Forbidden","kind":"json-schema","title":"Forbidden","data":{"allOf":[{"title":"Forbidden"},{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code.","minimum":403,"maximum":403}}},{"$ref":"#/components/schemas/BaseProblem"}]}},"components/schemas/Conflict":{"id":"components/schemas/Conflict","kind":"json-schema","title":"Conflict","data":{"allOf":[{"title":"Conflict"},{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code.","minimum":409,"maximum":409}}},{"$ref":"#/components/schemas/BaseProblem"}]}},"components/schemas/InvalidFields":{"id":"components/schemas/InvalidFields","kind":"json-schema","title":"InvalidFields","data":{"type":"array","description":"Invalid field details.","items":{"type":"object","properties":{"field":{"type":"string","description":"Name of the field.\nDot notation is used for nested object field names."},"message":{"description":"Message field.","type":"string"}}},"example":[{"field":"field1","message":"field1 is invalid"},{"field":"subObject.field2","message":"field2 is invalid"},{"field":"subObject.field2","message":"another error in the field2"}]}},"components/schemas/ValidationError":{"id":"components/schemas/ValidationError","kind":"json-schema","title":"ValidationError","data":{"allOf":[{"title":"Validation error"},{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code.","minimum":422,"maximum":422}}},{"$ref":"#/components/schemas/BaseProblem"},{"type":"object","properties":{"invalidFields":{"$ref":"#/components/schemas/InvalidFields"}}}]}},"components/schemas/TooManyRequests":{"id":"components/schemas/TooManyRequests","kind":"json-schema","title":"TooManyRequests","data":{"type":"object","additionalProperties":true,"minProperties":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC-7807 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7807"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"problem details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" JSON object."},"children":[]}]}]}],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Problem type in the form of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc3986"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reference."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It should provide human-readable documentation for the problem type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this member is not present, its value is assumed to be \"about:blank\"."},"children":[]}]}]}],"format":"uri","example":"about:blank"},"title":{"type":"string","description":"Short, human-readable summary of the problem type.\nOther than for the purposes of localization, this should not change from occurrence to occurrence of the problem.","example":"Rate Limit Exceeded"},"status":{"type":"integer","description":"HTTP status code.","minimum":429,"maximum":429},"detail":{"type":"string","description":"Human-readable explanation that is specific to this occurrence of the problem.","example":"A request cannot be executed because the user has sent too many requests within a certain period of time"},"instance":{"type":"string","description":"URI reference that identifies the specific occurrence of the problem.\nIt may or may not yield further information if dereferenced."}}}},"components/schemas/NotFound":{"id":"components/schemas/NotFound","kind":"json-schema","title":"NotFound","data":{"allOf":[{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code.","minimum":404,"maximum":404}}},{"$ref":"#/components/schemas/BaseProblem"}]}},"components/schemas/ResourceId":{"id":"components/schemas/ResourceId","kind":"json-schema","title":"ResourceId","data":{"type":"string","description":"Unique resource ID.","maxLength":50,"example":"4f6cf35x-2c4y-483z-a0a9-158621f77a21"}},"components/schemas/AML":{"id":"components/schemas/AML","kind":"json-schema","title":"AML","data":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the individual, or name of entity.","readOnly":true,"example":"Benjamin"},"lastName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last name of the individual."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value for single-named entities."},"children":[]}]}]}],"readOnly":true,"example":"Franklin"},"source":{"type":"string","readOnly":true,"description":"Describes which list the result is from."},"sourceType":{"readOnly":true,"description":"Describes the categories of the individual or entity.","type":"array","example":["sanctions","enforcements"],"items":{"type":"string","enum":["pep","sanctions","adverse-media","enforcements","state-owned-enterprise"]}},"gender":{"type":["string","null"],"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"individual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field describes the gender of the individual."},"children":[]}]}]}]},"title":{"type":["array","null"],"readOnly":true,"description":"Individual's job title.","example":["Postmaster General","Ambassador to France","Ambassador to Sweden","Supreme Executive Council of Commonwealth of Pennsylvania"],"items":{"type":"string"}},"type":{"type":"string","readOnly":true,"description":"Describes whether the source is an individual or an entity.","enum":["individual","entity"]},"legalBasis":{"type":"array","readOnly":true,"description":"List of references to legal documents, if they exist.","items":{"type":"string"}},"regime":{"type":["string","null"],"readOnly":true,"description":"Describes the government, administration, or political entity.","example":"United States Government"},"confidence":{"type":"string","description":"Degree of confidence in the source list information.","readOnly":true,"enum":["weak","medium","strong","very-strong"]},"nationality":{"type":"string","readOnly":true,"description":"Nationality of the individual or entity."},"address":{"type":"array","readOnly":true,"description":"Addresses associated with the individual or entity.","items":{"type":"object","properties":{"address":{"type":["string","null"],"readOnly":true,"description":"Street address line 1."},"address2":{"type":["string","null"],"readOnly":true,"description":"Street address line 2."},"city":{"type":["string","null"],"readOnly":true,"description":"City."},"region":{"type":["string","null"],"readOnly":true,"description":"State, province, or region."},"country":{"type":["string","null"],"readOnly":true,"description":"Country."},"birthplace":{"type":"boolean","default":false,"readOnly":true,"description":"Individual's place of birth."}}}},"dob":{"type":"array","readOnly":true,"description":"One or more possible dates of birth.","items":{"type":"string","readOnly":true,"description":"Date of birth.","format":"date","example":"1706-01-17"}},"aliases":{"type":"array","readOnly":true,"description":"List of aliases, if any.","items":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of alias.","readOnly":true},"lastName":{"type":"string","description":"Last name of alias.","readOnly":true},"authenticity":{"type":"string","description":"Degree of confidence in the alias.","readOnly":true,"enum":["strong","weak","unknown"]}}}},"passport":{"type":"array","readOnly":true,"description":"Individual's passport information.","items":{"type":"object","properties":{"number":{"type":"string","readOnly":true,"description":"Passport number."},"registrationDate":{"type":"string","format":"date","readOnly":true,"description":"Passport registration date."}}}},"comments":{"type":["string","null"],"readOnly":true,"description":"Additional information.\nThis content varies per list."},"metadata":{"type":["object","null"],"readOnly":true,"description":"Additional metadata on AML sources, when available.","properties":{"lookupId":{"type":"string","readOnly":true,"description":"Direct lookup identifier for the LexisNexis WorldCompliance Online Search Tool.","example":"1E66DAD6-A2E2-4DCB-BCAF-8CC92CD1DDEC"}}},"matchDetails":{"type":["object","null"],"description":"Details of the matching logic and confidence scoring.","properties":{"confidenceFactors":{"type":"array","readOnly":true,"description":"List of factors that contributed to the confidence score calculation.","items":{"type":"string","enum":["confidence_exact_country","confidence_mismatch_country","confidence_missing_country","confidence_exact_dob","confidence_mismatch_dob","confidence_missing_dob","confidence_exact_yob","confidence_inexact_yob","confidence_strong_hit_relevance","confidence_weak_hit_relevance","confidence_exact_full_name","confidence_fuzzy_full_name"]}},"matchCriteria":{"type":"array","readOnly":true,"description":"List of specific criteria that matched against the watchlist.","items":{"type":"string","enum":["match_exact_name","match_phonetic_first_name","match_phonetic_last_name","match_exact_full_name","match_aka_exact_name","match_aka_phonetic_first_name","match_aka_phonetic_last_name","match_aka_exact_full_name","match_fuzzy_nationality","match_exact_address","match_exact_city","match_exact_region","match_exact_country","match_exact_post_code"]}}}},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/Tag":{"id":"components/schemas/Tag","kind":"json-schema","title":"Tag","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use tags to organise and categorize customers or KYC documents based on keywords."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/api/tags/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["name","type"],"properties":{"id":{"description":"ID of the tag.","readOnly":true,"$ref":"#/components/schemas/ResourceId"},"name":{"description":"Unique name for the tag.\nTag names are not case-sensitive.","type":"string","maxLength":255,"pattern":"^[@~\\-\\.\\w\\s+]+$","example":"New"},"type":{"description":"Type of tag.\nTags of a specific type can only be assigned to corresponding entity types.\nFor example, you can only use customer tags on customers.","type":"string","enum":["customer","kyc-document","aml-check"]},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/AmlCheck":{"id":"components/schemas/AmlCheck","kind":"json-schema","title":"AmlCheck","data":{"type":"object","readOnly":true,"description":"AML check result.","properties":{"id":{"type":"string","description":"Unique resource ID.","maxLength":50,"example":"aml_chk_0YV8XJT2ZWDR398Q8NFEM7DEPM"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"websiteId":{"type":"string","description":"Website ID associated with the customer.","maxLength":50,"example":"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"},"reviewerId":{"type":["string","null"],"maxLength":50,"description":"User ID of the person who reviewed the AML check.","example":"44433322-2c4y-483z-a0a9-158621f77a21"},"reviewerType":{"type":["string","null"],"readOnly":true,"description":"Type of reviewer for the current review outcome.","enum":["human","bot"],"example":"bot"},"reviewerName":{"type":["string","null"],"description":"First and last name of the person who reviewed the AML check.\nIf the result is inherited, this field is set to \"bot\"."},"reviewStartTime":{"type":["string","null"],"format":"date-time","description":"Date and time when the AML check review is started."},"reviewTime":{"type":["string","null"],"format":"date-time","description":"Date and time when the AML check review is completed."},"priority":{"type":["string","null"],"default":null,"description":"Highest matched priority of all hits within an AML check."},"source":{"type":"string","description":"Source of the AML check.","enum":["sign-up","recurring","purchase"]},"status":{"type":"string","description":"Status of the AML check.","readOnly":true,"enum":["pending-review","in-review","no-match","confirmed-match","false-positive"],"x-enumDescriptions":{"pending-review":"Possible AML match detected and waiting to be manually reviewed.","in-review":"A manual AML match review is in progress.","no-match":"No possible AML match detected.","confirmed-match":"Possible AML match manually reviewed and marked as confirmed.","false-positive":"Possible AML match manually reviewed and marked as false positive."}},"customer":{"type":"object","properties":{"id":{"description":"ID of the customer.","$ref":"#/components/schemas/ResourceId"},"primaryAddress":{"type":"object","description":"Customer's data at the time of the AML check.","properties":{"firstName":{"type":"string","maxLength":45,"description":"Customer's first name at the time of the AML check."},"lastName":{"type":"string","maxLength":45,"description":"Customer's last name at the time of the AML check."},"dob":{"type":["string","null"],"format":"date","description":"Customer's date of birth.","example":"1971-02-14"},"address":{"description":"First line of the customer's street address at the time of the AML check.","type":["string","null"],"pattern":"^[\\u0000-\\uFFFF]+$","maxLength":60,"example":"36 Craven St"},"address2":{"description":"Second line of the customer's street address at the time of the AML check.","type":["string","null"],"pattern":"^[\\u0000-\\uFFFF]+$","maxLength":60},"city":{"description":"Customer's city of residence at the time of the AML check.","type":["string","null"],"pattern":"^[\\u0000-\\uFFFF]+$","maxLength":45,"example":"Austin"},"region":{"description":"Customer's region of residence at the time of the AML check.","type":["string","null"],"pattern":"^[\\u0000-\\uFFFF]+$","maxLength":45,"example":"Texas"},"country":{"type":["string","null"],"description":"Customer's country of residence at the time of the AML check."},"postalCode":{"description":"Customer's postal code at the time of the AML check.","type":["string","null"],"pattern":"^[\\w\\s\\-]+$","maxLength":10,"example":"WC2N 5NF"}}},"organizationId":{"type":"string","description":"ID of the customer's organization.","maxLength":50,"example":"org_0YVDM8RC7GDADADSBSMW124JA8"}}},"hits":{"description":"List of hits returned during the AML check.","type":"array","items":{"$ref":"#/components/schemas/AML"}},"tags":{"description":"List of AML check tags.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"provenance":{"type":["object","null"],"readOnly":true,"description":"Origin of the AML check result.","properties":{"inherited":{"type":"boolean","description":"Specifies if the result is inherited from a previous AML check.","example":true},"inheritedFromAmlCheckId":{"type":"string","description":"ID of the AML check from which the check inherits its result.","maxLength":50,"example":"aml_chk_0YV8XJT2ZWDR398Q8NFEM7DEPM"},"scope":{"type":"array","description":"Scope of what is inherited from the source AML check.","items":{"type":"string","enum":["status-only"]},"example":["status-only"]},"reasons":{"type":"array","description":"Reasons that triggered the inheritance of the result.","items":{"type":"string","enum":["customer_duplicated_by_person_exact_match","customer_duplicated_by_primary_phone_number_exact_match","customer_previous_check_exact_match"],"x-enumDescriptions":{"customer_duplicated_by_person_exact_match":"Customer identity exactly matched a check on another customer","customer_duplicated_by_primary_phone_number_exact_match":"Customer primary phone number exactly matched a check on another customer","customer_previous_check_exact_match":"Customer data exactly matched a previous check on the same customer"}},"example":["customer_duplicated_by_person_exact_match"]}}},"noMatchReason":{"readOnly":true,"description":"Reason for the no-match result.","type":["string","null"],"enum":["no_hits_found","mismatched_hits","hits_are_below_relevance_score_threshold","internal_system_error"],"example":"no_hits_found"},"noMatchDetails":{"readOnly":true,"description":"List of codes that explain the no-match result.","type":"array","items":{"type":"string"},"example":["top_hit_not_eligible_for_matching","search_shard_failures"]},"_links":{"type":"array","description":"Related links.","items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","customer"]}}}}}}},"components/schemas/AmlCheckReview":{"id":"components/schemas/AmlCheckReview","kind":"json-schema","title":"AmlCheckReview","data":{"type":"object","description":"AML check review.","properties":{"status":{"type":"string","description":"Status of the AML check.","enum":["confirmed-match","false-positive"]}}}},"components/schemas/AmlConfidence":{"id":"components/schemas/AmlConfidence","kind":"json-schema","title":"AmlConfidence","data":{"type":["string","null"],"description":"Degree of confidence to assign.","enum":["weak","medium","strong","very-strong"]}},"components/schemas/AmlCompoundConfidence":{"id":"components/schemas/AmlCompoundConfidence","kind":"json-schema","title":"AmlCompoundConfidence","data":{"type":"object","properties":{"addressMatch":{"type":"object","description":"Match for the customer's city or region, or both, is found.","properties":{"matchingCountry":{"$ref":"#/components/schemas/AmlConfidence"},"mismatchingCountry":{"$ref":"#/components/schemas/AmlConfidence"},"noCountry":{"$ref":"#/components/schemas/AmlConfidence"}}},"addressMismatch":{"type":"object","description":"Match for the customer's city or region, or both, is not found.","properties":{"matchingCountry":{"$ref":"#/components/schemas/AmlConfidence"},"mismatchingCountry":{"$ref":"#/components/schemas/AmlConfidence"},"noCountry":{"$ref":"#/components/schemas/AmlConfidence"}}},"noAddress":{"type":"object","description":"No city and no region is available to match against.","properties":{"matchingCountry":{"$ref":"#/components/schemas/AmlConfidence"},"mismatchingCountry":{"$ref":"#/components/schemas/AmlConfidence"},"noCountry":{"$ref":"#/components/schemas/AmlConfidence"}}}}}},"components/schemas/AmlPriority":{"id":"components/schemas/AmlPriority","kind":"json-schema","title":"AmlPriority","data":{"type":["string","null"],"description":"Priority level of matched AML customer information.","default":null,"enum":["p0","p1","p2","p3"]}},"components/schemas/AmlSettings":{"id":"components/schemas/AmlSettings","kind":"json-schema","title":"AmlSettings","data":{"type":"object","description":"Settings for AML checking.","properties":{"confidence":{"type":"object","description":"Confidence level settings for AML matches.","properties":{"dob":{"type":"object","description":"Confidence level settings for AML matches based on date of birth.","properties":{"exactMatch":{"description":"Exact match of the customer's date of birth and name is found.","$ref":"#/components/schemas/AmlCompoundConfidence"},"inexactMatch":{"description":"Exact match of the customer's date of birth and a fuzzy, or inexact, name match is found.","$ref":"#/components/schemas/AmlCompoundConfidence"}}},"noDob":{"type":"object","description":"Confidence level settings for AML matches based on a missing date of birth.","properties":{"exactMatch":{"description":"Exact match of the customer's name is found, but a date of birth is not.","$ref":"#/components/schemas/AmlCompoundConfidence"},"inexactMatch":{"description":"Fuzzy, or inexact match of the customer's name is found, but a date of birth is not.","$ref":"#/components/schemas/AmlCompoundConfidence"},"weakMatch":{"description":"Weak match of the customer's name is found, but a date of birth is not.","$ref":"#/components/schemas/AmlCompoundConfidence"}}},"yob":{"type":"object","description":"Confidence level settings for AML matches based on year of birth.","properties":{"exactMatch":{"description":"Exact match of the customer's year of birth and exact name is found.","$ref":"#/components/schemas/AmlCompoundConfidence"},"inexactMatch":{"description":"Exact match of the customer's year of birth and a fuzzy, or inexact, name match is found.","$ref":"#/components/schemas/AmlCompoundConfidence"}}},"inexactYob":{"type":"object","description":"Confidence level settings for AML matches based on a near match of year of birth.","properties":{"exactMatch":{"description":"Near match of the customer's year of birth and an exact name match is found.","$ref":"#/components/schemas/AmlCompoundConfidence"},"inexactMatch":{"description":"Near match of the customer's year of birth and a fuzzy, or inexact, name match is found.","$ref":"#/components/schemas/AmlCompoundConfidence"}}}}},"priority":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority level settings for AML source matches. "},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"p0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is critical priority level, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"p3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is low priority level."},"children":[]}]}]}],"properties":{"pep":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priorities for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pep"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" source type."},"children":[]}]}]}],"properties":{"veryStrong":{"$ref":"#/components/schemas/AmlPriority"},"strong":{"$ref":"#/components/schemas/AmlPriority"},"medium":{"$ref":"#/components/schemas/AmlPriority"},"weak":{"$ref":"#/components/schemas/AmlPriority"}}},"enforcements":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priorities for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enforcement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" source type."},"children":[]}]}]}],"properties":{"veryStrong":{"$ref":"#/components/schemas/AmlPriority"},"strong":{"$ref":"#/components/schemas/AmlPriority"},"medium":{"$ref":"#/components/schemas/AmlPriority"},"weak":{"$ref":"#/components/schemas/AmlPriority"}}},"stateOwnedEnterprise":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priorities for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state-owned-enterprise"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" source type."},"children":[]}]}]}],"properties":{"veryStrong":{"$ref":"#/components/schemas/AmlPriority"},"strong":{"$ref":"#/components/schemas/AmlPriority"},"medium":{"$ref":"#/components/schemas/AmlPriority"},"weak":{"$ref":"#/components/schemas/AmlPriority"}}},"sanctions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priorities for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sanctions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" source type."},"children":[]}]}]}],"properties":{"veryStrong":{"$ref":"#/components/schemas/AmlPriority"},"strong":{"$ref":"#/components/schemas/AmlPriority"},"medium":{"$ref":"#/components/schemas/AmlPriority"},"weak":{"$ref":"#/components/schemas/AmlPriority"}}},"adverseMedia":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priorities for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adverse-media"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" source type."},"children":[]}]}]}],"properties":{"veryStrong":{"$ref":"#/components/schemas/AmlPriority"},"strong":{"$ref":"#/components/schemas/AmlPriority"},"medium":{"$ref":"#/components/schemas/AmlPriority"},"weak":{"$ref":"#/components/schemas/AmlPriority"}}}}}}}},"components/schemas/Attachment":{"id":"components/schemas/Attachment","kind":"json-schema","title":"Attachment","data":{"type":"object","required":["fileId","relatedId","relatedType"],"properties":{"id":{"type":"string","readOnly":true,"description":"ID of the attachment.","maxLength":50,"example":"att_0YV7J787J0DW0918MQQMDHWA7M"},"fileId":{"type":"string","description":"ID of the linked file object.","maxLength":50,"example":"file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"},"relatedType":{"description":"Linked object type.","type":"string","enum":["customer","customer-timeline-comment","dispute","gateway-timeline-comment","invoice","invoice-timeline-comment","order-timeline-comment","organization","payment","plan","product","subscription","transaction","transaction-timeline-comment"]},"relatedId":{"description":"ID of the linked object.","type":"string"},"name":{"description":"Name of original attachment.","type":"string"},"description":{"description":"Description of the attachment.","type":"string"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","file"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"file":{"type":"object"}}}}}},"components/schemas/AuthenticationOptions":{"id":"components/schemas/AuthenticationOptions","kind":"json-schema","title":"AuthenticationOptions","data":{"type":"object","properties":{"passwordPattern":{"description":"Allowed password pattern.","type":["string","null"],"example":"/^[0-9]+$/"},"credentialTtl":{"description":"Default credential lifetime, in seconds.","type":"integer"},"authTokenTtl":{"description":"Default auth-token lifetime, in seconds.","type":"integer"},"resetTokenTtl":{"description":"Default reset-token lifetime, in seconds.","type":"integer"},"otpRequired":{"description":"Specifies if a One-Time Password (OTP) is required to exchange a token.","type":"boolean"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/CustomerId":{"id":"components/schemas/CustomerId","kind":"json-schema","title":"CustomerId","data":{"type":"string","description":"ID of the customer resource.","maxLength":50,"example":"cus_0YV7DDSDD1C8DA64KHH2W33CPF","x-basic":true}},"components/schemas/AuthenticationTokenResponse":{"id":"components/schemas/AuthenticationTokenResponse","kind":"json-schema","title":"Authentication token","data":{"type":"object","title":"Authentication token","required":["username"],"properties":{"username":{"description":"Username of the customer who is associated with the authentication token.","type":"string"},"customerId":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CustomerId"}]},"token":{"description":"ID of the authentication token.","type":"string","readOnly":true},"otpRequired":{"description":"Specifies if a One-Time Password (OTP) is required to exchange the authentication token.","type":"boolean"},"credentialId":{"description":"ID of the user associated with the authentication token.","readOnly":true,"$ref":"#/components/schemas/ResourceId"},"expiredTime":{"description":"Date and time when the token expired.","type":["string","null"],"format":"date-time"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/AuthenticationTokenPasswordMode":{"id":"components/schemas/AuthenticationTokenPasswordMode","kind":"json-schema","title":"AuthenticationTokenPasswordMode","data":{"type":"object","required":["username","password"],"properties":{"username":{"description":"Username associated with the authentication token.","type":"string"},"password":{"description":"Password associated with the authentication token.","type":"string","format":"password","writeOnly":true},"mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the authentication verification method."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"password"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" token requires the user to enter a password to log in."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"passwordless"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" token, requires a secret API key to log in."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To obtain an API key, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/api-keys/#manage-api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage API keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"writeOnly":true,"enum":["password"]},"customerId":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CustomerId"}]},"token":{"description":"ID of the authentication token.","type":"string","readOnly":true},"otpRequired":{"description":"Specifies if a One-Time Password (OTP) is required to exchange the authentication token.","type":"boolean"},"credentialId":{"description":"ID of the user associated with the authentication token.","readOnly":true,"$ref":"#/components/schemas/ResourceId"},"expiredTime":{"description":"Date and time when the token expired.","type":"string","format":"date-time"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/AuthenticationTokenPasswordlessMode":{"id":"components/schemas/AuthenticationTokenPasswordlessMode","kind":"json-schema","title":"AuthenticationTokenPasswordlessMode","data":{"type":"object","required":["customerId"],"properties":{"customerId":{"$ref":"#/components/schemas/CustomerId"},"mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the authentication verification method."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"password"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" token requires the user to enter a password to log in."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"passwordless"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" token, requires a secret API key to log in."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To obtain an API key, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/api-keys/#manage-api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage API keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"writeOnly":true,"enum":["passwordless"]},"token":{"description":"ID of the authentication token.","type":"string","readOnly":true},"otpRequired":{"description":"Specifies if a One-Time Password (OTP) is required to exchange the authentication token.","type":"boolean"},"credentialId":{"description":"ID of the user associated with the authentication token.","readOnly":true,"$ref":"#/components/schemas/ResourceId"},"expiredTime":{"description":"Date and time when the token expired.","type":"string","format":"date-time"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/AuthenticationToken":{"id":"components/schemas/AuthenticationToken","kind":"json-schema","title":"AuthenticationToken","data":{"type":"object","discriminator":{"propertyName":"mode","mapping":{"password":"#/components/schemas/AuthenticationTokenPasswordMode","passwordless":"#/components/schemas/AuthenticationTokenPasswordlessMode"}},"oneOf":[{"$ref":"#/components/schemas/AuthenticationTokenPasswordMode"},{"$ref":"#/components/schemas/AuthenticationTokenPasswordlessMode"}]}},"components/schemas/ApiKeyScope":{"id":"components/schemas/ApiKeyScope","kind":"json-schema","title":"ApiKeyScope","data":{"type":"object","properties":{"organizationId":{"description":"Array of account IDs.","type":"array","items":{"$ref":"#/components/schemas/ResourceId"}},"productId":{"description":"Array of product IDs.","type":"array","items":{"type":"string","description":"Unique resource ID.","maxLength":50,"example":"prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"}},"planId":{"description":"Array of plan IDs.","type":"array","items":{"type":"string","description":"Unique resource ID.","maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"}},"customFieldName":{"description":"Array of custom field names.","type":"array","items":{"type":"string","maxLength":60,"pattern":"^[\\w-]+$"}}},"example":{"organizationId":["organizationId-id-1"]}}},"components/schemas/AclPermissions":{"id":"components/schemas/AclPermissions","kind":"json-schema","title":"AclPermissions","data":{"type":"array","items":{"type":"string","format":"operationId"},"example":["PostFile","StorefrontGetAccount","StorefrontGetWebsite","StorefrontGetKycDocument","StorefrontPostKycDocument"]}},"components/schemas/Acl":{"id":"components/schemas/Acl","kind":"json-schema","title":"Acl","data":{"type":"array","description":"Access Control List (ACL) information.","items":{"type":"object","required":["scope","permissions"],"properties":{"scope":{"description":"Scope of the API key.","$ref":"#/components/schemas/ApiKeyScope"},"permissions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are creating a restricted API key, use this field to specify individual permissions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the wildcard character "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to provide full access."},"children":[]}]}]}],"$ref":"#/components/schemas/AclPermissions"}}}}},"components/schemas/CustomerJWT":{"id":"components/schemas/CustomerJWT","kind":"json-schema","title":"CustomerJWT","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the session.","maxLength":50,"example":"jwt_0YV7DEJX80CDRAKVTV478ZNJDR","readOnly":true},"type":{"description":"Type of session.","type":"string","readOnly":true,"enum":["customer"]},"token":{"description":"Token used for authentication.","type":"string","readOnly":true},"invalidate":{"description":"Specifies if the token must be invalidated after the exchange is performed.","type":"boolean","default":true,"example":true,"writeOnly":true},"oneTimePassword":{"description":"One-time password that is sent by email.\nThis value must contain digits only.","type":"string","pattern":"^[0-9]{6}$","example":"123456","writeOnly":true},"customerId":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CustomerId"}]},"acl":{"$ref":"#/components/schemas/Acl"},"customClaims":{"type":"object","additionalProperties":true,"example":{"documents":["identity-proof","address-proof"],"redirectUrl":"https://mywebsite.com"}},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"expiredTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the session expires."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default value is one hour after the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}],"type":"string","format":"date-time"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["customer"]}}}}}}},"components/schemas/Blocklist":{"id":"components/schemas/Blocklist","kind":"json-schema","title":"Blocklist","data":{"type":"object","required":["type","value"],"properties":{"id":{"type":"string","description":"ID of the blocklist.","readOnly":true,"maxLength":50,"example":"blkl_0YV8XTSH9MD578386XQDWSEBNF"},"type":{"description":"Type of blocklist.","type":"string","enum":["payment-card","bank-account","customer-id","email","email-domain","ip-address","country","fingerprint","bin","address"]},"value":{"description":"Value of the blocklist.","type":"string"},"expirationTime":{"description":"Date and time when the blocklist expires.","type":["string","null"],"format":"date-time"},"source":{"description":"Source that triggered the creation of the blocklist.","type":["string","null"],"readOnly":true,"enum":["automated-blocklists","manual-blocklists","risk-score-rules"],"example":"manual-blocklists"},"entityId":{"type":["string","null"],"readOnly":true,"description":"ID of the user, transaction or dispute that triggered the creation of the blocklist.","example":"txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/CouponRestrictionDiscountPerRedemption":{"id":"components/schemas/CouponRestrictionDiscountPerRedemption","kind":"json-schema","title":"CouponRestrictionDiscountPerRedemption","data":{"type":"object","description":"Restricts the number of times that the coupon can be applied by one\nredemption. For example, use this restriction to configure a coupon\nthat can only be applied to the first subscription renewal of a\nparticular product.","required":["type","quantity"],"properties":{"type":{"description":"Type of coupon restriction.","type":"string","enum":["discounts-per-redemption"]},"quantity":{"type":"integer","description":"Permitted number of discounts per redemption."}}}},"components/schemas/CurrencyCode":{"id":"components/schemas/CurrencyCode","kind":"json-schema","title":"CurrencyCode","data":{"type":"string","description":"Currency code in ISO 4217 format.","minLength":3,"maxLength":3,"example":"USD","x-label":"Currency","x-sortable":true}},"components/schemas/CouponRestrictionMaximumOrderAmount":{"id":"components/schemas/CouponRestrictionMaximumOrderAmount","kind":"json-schema","title":"CouponRestrictionMaximumOrderAmount","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a maximum order amount for a coupon application."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if the restriction amount is $20,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the coupon is only applied to invoices with a total amount of $20 or less."},"children":[]}]}]}],"required":["type","amount","currency"],"properties":{"type":{"type":"string","description":"Type of coupon restriction.","enum":["maximum-order-amount"]},"amount":{"type":"number","format":"double","description":"Maximum order amount that is allowed to apply the coupon."},"currency":{"$ref":"#/components/schemas/CurrencyCode"}}}},"components/schemas/CouponRestrictionMinimumOrderAmount":{"id":"components/schemas/CouponRestrictionMinimumOrderAmount","kind":"json-schema","title":"CouponRestrictionMinimumOrderAmount","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a minimum order amount for a coupon application. For"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"example, if the restriction amount is $20, the coupon is only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied to invoices with a total amount of $20 or more."},"children":[]}]}]}],"required":["type","amount","currency"],"properties":{"type":{"type":"string","description":"Type of coupon restriction.","enum":["minimum-order-amount"]},"amount":{"type":"number","format":"double","description":"Minimum order quantity that is required to apply the coupon."},"currency":{"$ref":"#/components/schemas/CurrencyCode"}}}},"components/schemas/CouponRestrictionPaidByTime":{"id":"components/schemas/CouponRestrictionPaidByTime","kind":"json-schema","title":"CouponRestrictionPaidByTime","data":{"type":"object","description":"Specifies a date and time at which a coupon redemption expires if the invoice is not paid.","required":["type","time"],"properties":{"type":{"description":"Type of coupon restriction.","type":"string","enum":["paid-by-time"]},"time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when a coupon redemption is no longer valid, and the coupon is removed from unpaid invoices if applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This date-time cannot be changed."},"children":[]}]}]}]}]}}}},"components/schemas/CouponRestrictionRestrictToInvoices":{"id":"components/schemas/CouponRestrictionRestrictToInvoices","kind":"json-schema","title":"CouponRestrictionRestrictToInvoices","data":{"type":"object","description":"Restricts a coupon to specific invoices.","required":["type","invoiceIds"],"properties":{"type":{"type":"string","description":"Type of coupon restriction.","enum":["restrict-to-invoices"]},"invoiceIds":{"type":"array","description":"Invoice IDs on which a coupon can be applied.","items":{"type":"string"}}}}},"components/schemas/CouponRestrictionRestrictToPlans":{"id":"components/schemas/CouponRestrictionRestrictToPlans","kind":"json-schema","title":"CouponRestrictionRestrictToPlans","data":{"type":"object","description":"Restricts a coupon to specific pricing plans.","required":["type","planIds"],"properties":{"type":{"type":"string","description":"Type of coupon restriction.","enum":["restrict-to-plans"]},"planIds":{"type":"array","description":"Plan IDs on which a coupon can be applied.","items":{"type":"string"}},"minimumQuantity":{"type":"integer","default":1,"description":"Minimum quantity that is required to apply the restriction and subsequent discount."}}}},"components/schemas/CouponRestrictionRestrictToProducts":{"id":"components/schemas/CouponRestrictionRestrictToProducts","kind":"json-schema","title":"CouponRestrictionRestrictToProducts","data":{"type":"object","description":"Restricts a coupon to specific products.","required":["type","productIds"],"properties":{"type":{"type":"string","description":"Type of coupon restriction.","enum":["restrict-to-products"]},"productIds":{"type":"array","description":"Product IDs on which a coupon can be applied.","items":{"type":"string"}},"minimumQuantity":{"type":"integer","default":1,"description":"Minimum quantity that is required to apply the restriction and subsequent discount."}}}},"components/schemas/CouponRestrictionRestrictToSubscriptions":{"id":"components/schemas/CouponRestrictionRestrictToSubscriptions","kind":"json-schema","title":"CouponRestrictionRestrictToSubscriptions","data":{"type":"object","description":"Restricts a coupon to specific order subscriptions.","required":["type","subscriptionIds"],"properties":{"type":{"type":"string","description":"Type of coupon restriction.","enum":["restrict-to-subscriptions"]},"subscriptionIds":{"type":"array","description":"Subscription IDs on which a coupon can be applied.","items":{"type":"string"}}}}},"components/schemas/RedemptionRestriction":{"id":"components/schemas/RedemptionRestriction","kind":"json-schema","title":"RedemptionRestriction","data":{"description":"Redemption restrictions.","type":"object","discriminator":{"propertyName":"type","mapping":{"discounts-per-redemption":"#/components/schemas/CouponRestrictionDiscountPerRedemption","maximum-order-amount":"#/components/schemas/CouponRestrictionMaximumOrderAmount","minimum-order-amount":"#/components/schemas/CouponRestrictionMinimumOrderAmount","paid-by-time":"#/components/schemas/CouponRestrictionPaidByTime","restrict-to-invoices":"#/components/schemas/CouponRestrictionRestrictToInvoices","restrict-to-plans":"#/components/schemas/CouponRestrictionRestrictToPlans","restrict-to-products":"#/components/schemas/CouponRestrictionRestrictToProducts","restrict-to-subscriptions":"#/components/schemas/CouponRestrictionRestrictToSubscriptions"}},"oneOf":[{"$ref":"#/components/schemas/CouponRestrictionDiscountPerRedemption"},{"$ref":"#/components/schemas/CouponRestrictionMaximumOrderAmount"},{"$ref":"#/components/schemas/CouponRestrictionMinimumOrderAmount"},{"$ref":"#/components/schemas/CouponRestrictionPaidByTime"},{"$ref":"#/components/schemas/CouponRestrictionRestrictToInvoices"},{"$ref":"#/components/schemas/CouponRestrictionRestrictToPlans"},{"$ref":"#/components/schemas/CouponRestrictionRestrictToProducts"},{"$ref":"#/components/schemas/CouponRestrictionRestrictToSubscriptions"}]}},"components/schemas/CouponRedemption":{"id":"components/schemas/CouponRedemption","kind":"json-schema","title":"CouponRedemption","data":{"type":"object","description":"Coupon redemption log.","properties":{"id":{"type":"string","readOnly":true,"description":"Unique resource ID.","maxLength":50,"example":"cpn_rdm_01HXC82EEPW6YD3MPWJY7151VR"},"couponId":{"type":"string","description":"ID of the coupon.","maxLength":50,"example":"cpn_0YVCNKF81GD778N4YNVGDJK558"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"additionalRestrictions":{"description":"Additional coupon redemption restrictions.","type":"array","items":{"$ref":"#/components/schemas/RedemptionRestriction"}},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"canceledTime":{"description":"Date and time when the coupon is canceled.","readOnly":true,"x-sortable":true,"type":["string","null"],"format":"date-time"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","customer","coupon"]}}}}}}},"components/schemas/DiscountContext":{"id":"components/schemas/DiscountContext","kind":"json-schema","title":"DiscountContext","data":{"type":"string","description":"Context in which the discount applies.","default":"items","x-label":"Context","x-sortable":true,"x-basic":true,"x-enumDescriptions":{"items":"items (less discounts)","shipping":"shipping (less discounts)","items-and-shipping":"items and shipping (less discounts)"},"enum":["items","shipping","items-and-shipping"]}},"components/schemas/DiscountFixed":{"id":"components/schemas/DiscountFixed","kind":"json-schema","title":"DiscountFixed","data":{"type":"object","description":"Coupon fixed amount discount.","required":["amount","currency","type"],"properties":{"amount":{"description":"Amount of discount.","type":"number","format":"double","minimum":0.01},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"type":{"type":"string","enum":["fixed"],"x-label":"Type","x-sortable":true,"x-basic":true},"context":{"$ref":"#/components/schemas/DiscountContext"}}}},"components/schemas/DiscountPercent":{"id":"components/schemas/DiscountPercent","kind":"json-schema","title":"DiscountPercent","data":{"type":"object","description":"Coupon percent discount.","required":["value","type"],"properties":{"value":{"description":"Percentage of discount.","type":"number","format":"double","minimum":0.01,"maximum":100},"type":{"type":"string","enum":["percent"],"x-label":"Type","x-sortable":true,"x-basic":true},"context":{"$ref":"#/components/schemas/DiscountContext"}}}},"components/schemas/Discount":{"id":"components/schemas/Discount","kind":"json-schema","title":"Discount","data":{"type":"object","description":"Coupon discount.","discriminator":{"propertyName":"type","mapping":{"fixed":"#/components/schemas/DiscountFixed","percent":"#/components/schemas/DiscountPercent"}},"oneOf":[{"$ref":"#/components/schemas/DiscountFixed"},{"$ref":"#/components/schemas/DiscountPercent"}]}},"components/schemas/CouponRestrictionRedemptionsPerCustomer":{"id":"components/schemas/CouponRestrictionRedemptionsPerCustomer","kind":"json-schema","title":"CouponRestrictionRedemptionsPerCustomer","data":{"type":"object","description":"Restricts the number of times that a coupon can be redeemed by one\ncustomer. For example, use this restriction to limit the number of\nredemptions to one per customer.","required":["type","quantity"],"properties":{"type":{"type":"string","description":"Type of coupon restriction.","enum":["redemptions-per-customer"]},"quantity":{"type":"integer","description":"Permitted number of redemptions per customer."}}}},"components/schemas/CouponRestrictionRestrictToBxgy":{"id":"components/schemas/CouponRestrictionRestrictToBxgy","kind":"json-schema","title":"CouponRestrictionRestrictToBxgy","data":{"type":"object","description":"Provides \"buy X get Y\" promotions.\nThese promotions incentivize new customers to buy and also reward existing customers.\nThis restriction type enables you to add discounted plans to an invoice when a certain quantity of other plans are purchased.\nFor example, if a customer buys two or more books, they get one free bookmark.","required":["type","buy","get"],"properties":{"type":{"type":"string","description":"Type of coupon restriction.","enum":["restrict-to-bxgy"]},"buy":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more plan and quantity definitions that must be purchased to receive all plans and quantities that are defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"get"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instruction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"planId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values in this array must be unique."},"children":[]}]}]}],"minItems":1,"items":{"type":"object","required":["planId","quantity"],"properties":{"planId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plan ID of the item being purchased."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value must be unique within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buy.items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}],"maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"},"quantity":{"type":"integer","minimum":1,"description":"Total quantity of the associated plan ID that must be purchased for this restriction to apply."}}}},"get":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more plan and quantity definitions that are added to a purchase if all definitions in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" condition are met."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"planId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values in this array must be unique."},"children":[]}]}]}],"minItems":1,"items":{"type":"object","required":["planId","quantity"],"properties":{"planId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plan ID of the item that is to be received by the customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value must be unique within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"get.items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}],"maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"},"quantity":{"type":"integer","minimum":1,"description":"Total quantity of the associated plan ID that is to be received by the customer."}}}}}}},"components/schemas/CouponRestrictionRestrictToCountries":{"id":"components/schemas/CouponRestrictionRestrictToCountries","kind":"json-schema","title":"CouponRestrictionRestrictToCountries","data":{"type":"object","description":"Restricts a coupon for use in specific countries.","required":["type","countries"],"properties":{"type":{"type":"string","description":"Type of coupon restriction.","enum":["restrict-to-countries"]},"countries":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Countries where the coupon can be applied, in ISO Alpha-2 code format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For examples, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/obp/ui/#search/code/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO.org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}}},"components/schemas/CouponRestrictionRestrictToCustomerTags":{"id":"components/schemas/CouponRestrictionRestrictToCustomerTags","kind":"json-schema","title":"CouponRestrictionRestrictToCustomerTags","data":{"type":"object","description":"Restricts a coupon to customers with specific tags.","required":["type","tags","requireAllTags"],"properties":{"type":{"type":"string","description":"Type of coupon restriction.","enum":["restrict-to-customer-tags"]},"tags":{"type":"array","description":"Customer tags on which a coupon can be applied.","items":{"type":"string"}},"requireAllTags":{"type":"boolean","description":"Specifies if the customer must have all listed tags,\nor at least one of the listed tags, to redeem a coupon.","enum":[true,false],"x-enumDescriptions":{"true":"Customer must have all listed tags to redeem a coupon.","false":"Customer must have at least one of the listed tags to redeem a coupon."}}}}},"components/schemas/CouponRestrictionRestrictToCustomers":{"id":"components/schemas/CouponRestrictionRestrictToCustomers","kind":"json-schema","title":"CouponRestrictionRestrictToCustomers","data":{"type":"object","description":"Restricts a coupon to specific customers.","required":["type","customerIds"],"properties":{"type":{"type":"string","description":"Type of coupon restriction.","enum":["restrict-to-customers"]},"customerIds":{"type":"array","description":"Customer IDs on which a coupon can be applied.","items":{"type":"string"}}}}},"components/schemas/CouponRestrictionExclusiveApplication":{"id":"components/schemas/CouponRestrictionExclusiveApplication","kind":"json-schema","title":"CouponRestrictionExclusiveApplication","data":{"type":"object","description":"Restricts a coupon so that it cannot be used in combination with other coupons.\nIf more than one coupon is active, a coupon with this restriction is only applied if it provides a larger discount than the other coupons combined.\nIf a coupon with this restriction is applied, all other coupons are removed.","required":["type"],"properties":{"type":{"type":"string","description":"Type of coupon restriction.","enum":["restrict-to-exclusive-application"]}}}},"components/schemas/CouponRestrictionTotalRedemptions":{"id":"components/schemas/CouponRestrictionTotalRedemptions","kind":"json-schema","title":"CouponRestrictionTotalRedemptions","data":{"type":"object","description":"Restricts the number of times a coupon can be redeemed by different customers.","required":["type","quantity"],"properties":{"type":{"type":"string","description":"Type of coupon restriction.","enum":["total-redemptions"]},"quantity":{"type":"integer","description":"Permitted total number of redemptions."}}}},"components/schemas/CouponRestriction":{"id":"components/schemas/CouponRestriction","kind":"json-schema","title":"CouponRestriction","data":{"description":"Coupon restrictions.","type":"object","discriminator":{"propertyName":"type","mapping":{"discounts-per-redemption":"#/components/schemas/CouponRestrictionDiscountPerRedemption","maximum-order-amount":"#/components/schemas/CouponRestrictionMaximumOrderAmount","minimum-order-amount":"#/components/schemas/CouponRestrictionMinimumOrderAmount","paid-by-time":"#/components/schemas/CouponRestrictionPaidByTime","redemptions-per-customer":"#/components/schemas/CouponRestrictionRedemptionsPerCustomer","restrict-to-bxgy":"#/components/schemas/CouponRestrictionRestrictToBxgy","restrict-to-countries":"#/components/schemas/CouponRestrictionRestrictToCountries","restrict-to-customer-tags":"#/components/schemas/CouponRestrictionRestrictToCustomerTags","restrict-to-customers":"#/components/schemas/CouponRestrictionRestrictToCustomers","restrict-to-exclusive-application":"#/components/schemas/CouponRestrictionExclusiveApplication","restrict-to-invoices":"#/components/schemas/CouponRestrictionRestrictToInvoices","restrict-to-plans":"#/components/schemas/CouponRestrictionRestrictToPlans","restrict-to-products":"#/components/schemas/CouponRestrictionRestrictToProducts","restrict-to-subscriptions":"#/components/schemas/CouponRestrictionRestrictToSubscriptions","total-redemptions":"#/components/schemas/CouponRestrictionTotalRedemptions"}},"oneOf":[{"$ref":"#/components/schemas/CouponRestrictionDiscountPerRedemption"},{"$ref":"#/components/schemas/CouponRestrictionExclusiveApplication"},{"$ref":"#/components/schemas/CouponRestrictionMaximumOrderAmount"},{"$ref":"#/components/schemas/CouponRestrictionMinimumOrderAmount"},{"$ref":"#/components/schemas/CouponRestrictionPaidByTime"},{"$ref":"#/components/schemas/CouponRestrictionRedemptionsPerCustomer"},{"$ref":"#/components/schemas/CouponRestrictionRestrictToBxgy"},{"$ref":"#/components/schemas/CouponRestrictionRestrictToCountries"},{"$ref":"#/components/schemas/CouponRestrictionRestrictToCustomerTags"},{"$ref":"#/components/schemas/CouponRestrictionRestrictToCustomers"},{"$ref":"#/components/schemas/CouponRestrictionRestrictToInvoices"},{"$ref":"#/components/schemas/CouponRestrictionRestrictToPlans"},{"$ref":"#/components/schemas/CouponRestrictionRestrictToProducts"},{"$ref":"#/components/schemas/CouponRestrictionRestrictToSubscriptions"},{"$ref":"#/components/schemas/CouponRestrictionTotalRedemptions"}]}},"components/schemas/Coupon":{"id":"components/schemas/Coupon","kind":"json-schema","title":"Coupon","data":{"type":"object","description":"Coupons and discounts.","required":["discount","issuedTime"],"properties":{"id":{"type":"string","description":"ID of the coupon.\nThis value is also known as the coupon redemption code.","readOnly":true,"maxLength":50,"example":"cpn_0YVCNKF81GD778N4YNVGDJK558"},"discount":{"$ref":"#/components/schemas/Discount"},"restrictions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coupon restrictions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values in this array must be unique."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/CouponRestriction"}},"redemptionsCount":{"type":"integer","description":"Total number of times that a coupon is redeemed.","minimum":0,"readOnly":true},"status":{"type":"string","description":"Specifies the current status of the coupon.","readOnly":true,"enum":["draft","issued","expired"]},"description":{"type":"string","x-basic":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of the coupon."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to provide a description for the invoice discount item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is empty,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the invoice discount item description uses the related coupon ID,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the following format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Coupon \"COUPON-ID\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"issuedTime":{"description":"Date and time when the coupon is issued.\nThis value may also be described as start time of the coupon.","type":"string","x-label":"Valid from","x-sortable":true,"x-basic":true,"format":"date-time"},"expiredTime":{"description":"Date and time when the coupon expires.","type":["string","null"],"x-label":"Valid until","x-sortable":true,"x-basic":true,"format":"date-time"},"revision":{"description":"Number of times the coupon data has been modified.\n\nUse the revision number when analyzing webhook data to\ndetermine if a change should take precedence over the current\nrepresentation.","type":"integer","readOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/CouponExpiration":{"id":"components/schemas/CouponExpiration","kind":"json-schema","title":"CouponExpiration","data":{"type":"object","required":["expiredTime"],"properties":{"expiredTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the coupon expires."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value must be greater than the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuedTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field contains a null or empty string, the coupon expires immediately."},"children":[]}]}]}],"type":"string","format":"date-time"}}}},"components/schemas/BlankProblem":{"id":"components/schemas/BlankProblem","kind":"json-schema","title":"BlankProblem","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Problem Details JSON Object ["},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7807"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC7807"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]."},"children":[]}]}]}],"type":"object","minProperties":1,"additionalProperties":true,"properties":{"status":{"type":"integer","description":"HTTP status code.","minimum":400,"maximum":599},"title":{"type":"string","description":"Short, human-readable summary of the problem type.\nIt SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."}}}},"components/schemas/DocumentedProblem":{"id":"components/schemas/DocumentedProblem","kind":"json-schema","title":"DocumentedProblem","data":{"type":"object","allOf":[{"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URI reference ["},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc3986"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC3986"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] that identifies the problem type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It should provide human-readable documentation for the problem type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this member is not present, its value is assumed to be \"about:blank\"."},"children":[]}]}]}],"format":"uri","example":"https://www.rebilly.com/docs/"}}},{"$ref":"#/components/schemas/BlankProblem"}]}},"components/schemas/DetailedProblem":{"id":"components/schemas/DetailedProblem","kind":"json-schema","title":"DetailedProblem","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/BlankProblem"},{"properties":{"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence of the problem."}}}]}},"components/schemas/Problem":{"id":"components/schemas/Problem","kind":"json-schema","title":"Problem","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/DocumentedProblem"},{"$ref":"#/components/schemas/DetailedProblem"}]}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/Problem"},{"properties":{"error":{"deprecated":true,"type":"string"}}}]}},"components/schemas/CustomerCredential":{"id":"components/schemas/CustomerCredential","kind":"json-schema","title":"CustomerCredential","data":{"type":"object","required":["username","password","customerId"],"properties":{"id":{"type":"string","description":"ID of the credential.","readOnly":true,"maxLength":50,"example":"cus_crd_0YV9Y706QGCB39FQD380G1ZHZH"},"username":{"description":"Username associated with the credential.","type":"string"},"password":{"description":"Password associated with the credential.","type":"string","format":"password","writeOnly":true},"customerId":{"$ref":"#/components/schemas/CustomerId"},"expiredTime":{"description":"Date and time when the credential expires.","type":["string","null"],"format":"date-time"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","customer"]}}}}}}},"components/schemas/ArrayCustomField":{"id":"components/schemas/ArrayCustomField","kind":"json-schema","title":"ArrayCustomField","data":{"type":"object","required":["type"],"properties":{"name":{"description":"Name of the custom field.","type":"string","readOnly":true},"type":{"description":"Describes the data type.\nThe custom field type value cannot be changed.\n\nArray of strings with up to 255 characters.\nThe maximum size is 1000 elements.","type":"string","enum":["array"]},"description":{"description":"Description of the custom field.","type":["string","null"]},"isEnabled":{"description":"Specifies if the custom field is enabled.","type":"boolean","default":true},"additionalSchema":{"type":["object","null"],"description":"Additional schema which adds additional values constrains.","properties":{"allowedValues":{"description":"List of allowed values.","type":"array","items":{"type":"string"}},"required":{"description":"Specifies if this value is required.\nThis value can be combined with any parameter and is available for custom fields of any type.","type":"boolean"},"default":{"description":"Default value.","type":"array","items":{"type":"string"}}}},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/BooleanCustomField":{"id":"components/schemas/BooleanCustomField","kind":"json-schema","title":"BooleanCustomField","data":{"type":"object","required":["type"],"properties":{"name":{"description":"Name of the custom field.","type":"string","readOnly":true},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the data type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom field type value cannot be changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}],"type":"string","enum":["boolean"]},"description":{"description":"Description of the custom field.","type":["string","null"]},"isEnabled":{"description":"Specifies if custom field is enabled.","type":"boolean","default":true},"additionalSchema":{"type":["object","null"],"description":"Additional schema which adds additional values constrains.","properties":{"required":{"description":"Specifies if this value is required.","type":"boolean"},"default":{"description":"Default value.","type":"boolean"}}},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/DateCustomField":{"id":"components/schemas/DateCustomField","kind":"json-schema","title":"DateCustomField","data":{"type":"object","required":["type"],"properties":{"name":{"description":"Name of the custom field.","type":"string","readOnly":true},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the data type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom field type value cannot be changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full-date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format (YYYY-MM-DD)."},"children":[]}]}]}],"type":"string","enum":["date"]},"description":{"description":"Description of the custom field.","type":["string","null"]},"isEnabled":{"description":"Specifies if custom field is enabled.","type":"boolean","default":true},"additionalSchema":{"type":["object","null"],"description":"Additional schema which adds additional values constrains.","properties":{"required":{"description":"Specifies if this value is required.","type":"boolean"},"default":{"description":"Default value.","type":"string","format":"date"}}},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/DateTimeCustomField":{"id":"components/schemas/DateTimeCustomField","kind":"json-schema","title":"DateTimeCustomField","data":{"type":"object","required":["type"],"properties":{"name":{"description":"Name of the custom field.","type":"string","readOnly":true},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the data type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom field type value cannot be changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date-time"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format (YYYY-MM-DDTHH:MM:SSZ)."},"children":[]}]}]}],"type":"string","enum":["datetime"]},"description":{"description":"Description of the custom field.","type":["string","null"]},"isEnabled":{"description":"Specifies if custom field is enabled.","type":"boolean","default":true},"additionalSchema":{"type":["object","null"],"description":"Additional schema which adds additional values constrains.","properties":{"required":{"description":"Specifies if this value is required.","type":"boolean"},"default":{"description":"Default value.","type":"string","format":"date-time"}}},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/IntegerCustomField":{"id":"components/schemas/IntegerCustomField","kind":"json-schema","title":"IntegerCustomField","data":{"type":"object","required":["type"],"properties":{"name":{"description":"Name of the custom field.","type":"string","readOnly":true},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the data type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom field type value cannot be changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardinal value of between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-2^31"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2^31-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["integer"]},"description":{"description":"Description of the custom field.","type":["string","null"]},"isEnabled":{"description":"Specifies if custom field is enabled.","type":"boolean","default":true},"additionalSchema":{"type":["object","null"],"description":"Additional schema which adds additional values constrains.","properties":{"minimum":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum allowed integer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value can be combined with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maximum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}],"type":"integer"},"maximum":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum allowed integer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value can be combined with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}],"type":"integer"},"required":{"description":"Specifies if this value is required.","type":"boolean"},"default":{"description":"Default value.","type":"integer"}}},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/NumberCustomField":{"id":"components/schemas/NumberCustomField","kind":"json-schema","title":"NumberCustomField","data":{"type":"object","required":["type"],"properties":{"name":{"description":"Name of the custom field.","type":"string","readOnly":true},"type":{"description":"Describes the data type.\nThe custom field type value cannot be changed.\n\nFloat value. This field also accepts cardinal values which are interpreted as float.","type":"string","enum":["number"]},"description":{"description":"Description of the custom field.","type":["string","null"]},"isEnabled":{"description":"Specifies if custom field is enabled.","type":"boolean","default":true},"additionalSchema":{"type":["object","null"],"description":"Additional schema which adds additional values constrains.","properties":{"minimum":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum allowed number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value can be combined with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maximum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}],"type":"number","format":"double"},"maximum":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum allowed number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value can be combined with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}],"type":"number","format":"double"},"required":{"description":"Specifies if this value is required.","type":"boolean"},"default":{"description":"Default value.","type":"number","format":"double"}}},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/StringCustomField":{"id":"components/schemas/StringCustomField","kind":"json-schema","title":"StringCustomField","data":{"type":"object","required":["type"],"properties":{"name":{"description":"Name of the custom field.","type":"string","readOnly":true},"type":{"description":"Describes the data type.\nThe custom field type cannot be changed.\n\nRegular string of up to 255 characters.","type":"string","enum":["string"]},"description":{"description":"Description of the custom field.","type":["string","null"]},"isEnabled":{"description":"Specifies if custom field is enabled.","type":"boolean","default":true},"additionalSchema":{"type":["object","null"],"description":"Additional schema which adds additional values constrains.","properties":{"allowedValues":{"description":"List of allowed values.","type":"array","items":{"type":"string"}},"maxLength":{"description":"Maximum allowed string length .\nA maximum length of 4000 characters can be configured.\nBy default, this value is set to 255.","type":"integer"},"pattern":{"description":"Allowed regular expression of a string.","type":"string","example":"/^[0-9]+$/"},"required":{"description":"Specifies if this value is required.","type":"boolean"},"default":{"description":"Default value.","type":"string"}}},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/MonetaryCustomField":{"id":"components/schemas/MonetaryCustomField","kind":"json-schema","title":"MonetaryCustomField","data":{"type":"object","required":["type"],"properties":{"name":{"description":"Name of the custom field.","type":"string","readOnly":true},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the data type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom field type cannot be changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of 3-letter currency, code, and amount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"currency\": \"EUR\", \"amount\": 25.30}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["monetary"]},"description":{"description":"Description of the custom field.","type":["string","null"]},"isEnabled":{"description":"Specifies if custom field is enabled.","type":"boolean","default":true},"additionalSchema":{"type":["object","null"],"description":"Additional schema which adds additional values constrains.","properties":{"required":{"description":"Specifies if this value is required.","type":"boolean"},"default":{"description":"Default value.","type":"object","properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"type":"number","format":"double"}}}}},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/CustomField":{"id":"components/schemas/CustomField","kind":"json-schema","title":"CustomField","data":{"description":"Separate custom field schema.","type":"object","discriminator":{"propertyName":"type","mapping":{"array":"#/components/schemas/ArrayCustomField","boolean":"#/components/schemas/BooleanCustomField","date":"#/components/schemas/DateCustomField","datetime":"#/components/schemas/DateTimeCustomField","integer":"#/components/schemas/IntegerCustomField","number":"#/components/schemas/NumberCustomField","string":"#/components/schemas/StringCustomField","monetary":"#/components/schemas/MonetaryCustomField"}},"oneOf":[{"$ref":"#/components/schemas/ArrayCustomField"},{"$ref":"#/components/schemas/BooleanCustomField"},{"$ref":"#/components/schemas/DateCustomField"},{"$ref":"#/components/schemas/DateTimeCustomField"},{"$ref":"#/components/schemas/IntegerCustomField"},{"$ref":"#/components/schemas/NumberCustomField"},{"$ref":"#/components/schemas/StringCustomField"},{"$ref":"#/components/schemas/MonetaryCustomField"}]}},"components/schemas/WebsiteId":{"id":"components/schemas/WebsiteId","kind":"json-schema","title":"WebsiteId","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the website."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A website is where an organization obtains a customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain an organization ID and website ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":50,"example":"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"}},"components/schemas/PaymentMethod":{"id":"components/schemas/PaymentMethod","kind":"json-schema","title":"PaymentMethod","data":{"type":"string","description":"Payment method.","enum":["payment-card","ach","cash","check","paypal","AdvCash","Aera","Affirm","Afterpay","Aircash","Airpay","Alfa-click","Alipay","AmazonPay","Apple Pay","AstroPay Card","AstroPay-GO","BankSEND","BankReferenced","bank-transfer","bank-transfer-2","bank-transfer-3","bank-transfer-4","bank-transfer-5","bank-transfer-6","bank-transfer-7","bank-transfer-8","bank-transfer-9","Baloto","Beeline","Belfius-direct-net","bitcoin","Bizum","Blik","Boleto","Boleto-2","Boleto-3","cash-deposit","CASHlib","CashToCode","CCAvenue","China UnionPay","Clearpay","Cleo","CODVoucher","Conekta-oxxo","Conekta-spei","cryptocurrency","Cupon-de-pagos","CyberSource","Dimoco-pay-smart","Directa24Card","domestic-cards","Efecty","echeck","ecoPayz","ecoPayzTurkey","ecoVoucher","EPS","ePay.bg","Ethereum","e-wallet","ezyEFT","eZeeWallet","FasterPay","Flexepin","Giropay","Google Pay","Gpaysafe","iCashOne Voucher","iDebit","iDEAL","ING-homepay","INOVAPAY-pin","INOVAPAY-wallet","InstaDebit","InstantPayments","instant-bank-transfer","Interac-online","Interac-eTransfer","Interac-express-connect","Interac","invoice","iWallet","Jeton","JetonCash","jpay","KakaoPay","Khelocard","Klarna","KNOT","Litecoin","loonie","LPG-online","LPG-payment-card","Matrix","MaxiCash","Megafon","MercadoPago","MiFinity-eWallet","miscellaneous","MobilePay","Mollie","Multibanco","Bancontact","Bancontact-mobile","MTS","MuchBetter","MuchBetterVoucher","MyFatoorah","Neosurf","Netbanking","Neteller","Nordea-Solo","NordikCoin","OchaPay","online-bank-transfer","Onlineueberweisen","oriental-wallet","OXXO","P24","Pagadito","PagoEffectivo","Pagsmile-lottery","Pagsmile-deposit-express","PayCash","Payco","Payeer","PaymentAsia-crypto","Paysafecard","PayTabs","Pay4Fun","Paynote","Paymero","Paymero-QR","PayU","PayULatam","Perfect-money","Piastrix","PIX","PIX-Automatico","PinPay","phone","PhonePe","POLi","PostFinance-card","PostFinance-e-finance","QIWI","QPay","QQPay","Quickpay","rapyd-checkout","rebilly-hosted-payment-form","Resurs","reverse-withdrawal","Ripple","SafetyPay","Samsung Pay","SEPA","Siirto","Skrill","Skrill Rapid Transfer","SMSVoucher","Sofort","SparkPay","SPEI","swift-dbt","Tele2","Telr","Terminaly-RF","Tether","ToditoCash-card","Trustly","Tupay","TWINT","UniCrypt","UPayCard","UPI","USD-coin","VCreditos","VegaWallet","VenusPoint","Viva","voucher","voucher-2","voucher-3","voucher-4","Wallet88","Webmoney","Webpay","Webpay-2","Webpay Card","WeChat Pay","XPay-P2P","XPay-QR","Yandex-money","Zotapay","Zimpler","Zip"]}},"components/schemas/ResourceCustomFields":{"id":"components/schemas/ResourceCustomFields","kind":"json-schema","title":"ResourceCustomFields","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use custom fields to extend a resource scheme to include custom data that is not provided as a common field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/custom-fields"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","default":{},"example":{"foo":"bar"}}},"components/schemas/ContactPhoneNumbers":{"id":"components/schemas/ContactPhoneNumbers","kind":"json-schema","title":"ContactPhoneNumbers","data":{"description":"List of phone numbers associated with the contact.","type":"array","items":{"type":"object","required":["label","value"],"properties":{"label":{"description":"Phone number label or name.","type":"string","maxLength":45,"example":"main"},"value":{"description":"Phone number value.","type":"string","maxLength":50,"example":"1-512-777-0269"},"primary":{"description":"Specifies if the phone number is the contact's primary phone number.","type":"boolean","example":true}}}}},"components/schemas/ContactEmails":{"id":"components/schemas/ContactEmails","kind":"json-schema","title":"ContactEmails","data":{"description":"List of email addresses associated with the contact.","type":"array","items":{"type":"object","required":["label","value"],"properties":{"label":{"description":"Email label or name.","type":"string","maxLength":45,"example":"main"},"value":{"description":"Email address value.","type":"string","format":"email","maxLength":255,"example":"rebilly@example.com"},"primary":{"description":"Specifies if the email address is the contact's primary email address.","type":"boolean","example":true}}}}},"components/schemas/ContactObject":{"id":"components/schemas/ContactObject","kind":"json-schema","title":"ContactObject","data":{"type":"object","description":"Contact's information.","properties":{"firstName":{"description":"Contact's first name.","type":["string","null"],"pattern":"^[\\u0000-\\uFFFF]+$","maxLength":45,"example":"Benjamin"},"lastName":{"description":"Contact's last name.","type":["string","null"],"pattern":"^[\\u0000-\\uFFFF]+$","maxLength":45,"example":"Franklin"},"organization":{"description":"Contact's organization.","type":["string","null"],"pattern":"^[\\u0000-\\uFFFF]+$","maxLength":255,"example":"Rebilly"},"address":{"description":"First line of the contact's street address.","type":["string","null"],"pattern":"^[\\u0000-\\uFFFF]+$","maxLength":60,"example":"36 Craven St"},"address2":{"description":"Second line of the contact's street address.","type":["string","null"],"pattern":"^[\\u0000-\\uFFFF]+$","maxLength":60},"city":{"description":"Contact's city of residence.","type":["string","null"],"pattern":"^[\\u0000-\\uFFFF]+$","maxLength":45,"example":"Austin"},"region":{"description":"Contact's region of residence.","type":["string","null"],"pattern":"^[\\u0000-\\uFFFF]+$","maxLength":45,"example":"Texas"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact's country of residence in ISO 3166 alpha-2 country code."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For examples, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/obp/ui/#search/code/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO.org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"pattern":"^[A-Z]{2}$","maxLength":2,"example":"GB"},"postalCode":{"description":"Contact's postal code.","type":["string","null"],"pattern":"^[\\w\\s\\-]+$","maxLength":10,"example":"WC2N 5NF"},"phoneNumbers":{"$ref":"#/components/schemas/ContactPhoneNumbers"},"emails":{"$ref":"#/components/schemas/ContactEmails"},"dob":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact's date of birth in ISO-8601 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"type":["string","null"],"format":"date","example":"1980-04-01"},"jobTitle":{"description":"Contact's job title.","type":["string","null"],"pattern":"^[\\u0000-\\uFFFF]+$","maxLength":255,"example":"CEO"},"hash":{"description":"Hash value for the contact.\nUse this value to compare contacts for identical attribute values.","type":"string","maxLength":40,"example":"056ae6d97c788b9e98b049ebafd7b229bf852221","readOnly":true}}}},"components/schemas/Company":{"id":"components/schemas/Company","kind":"json-schema","title":"Company","data":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company information that is associated with the customer's primary email address domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a paid feature, to enable it "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/support/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact Rebilly"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"readOnly":true,"properties":{"name":{"type":["string","null"],"description":"Name of the company."},"domain":{"type":"string","description":"Website domain of the company."},"yearFounded":{"type":["number","null"],"description":"Founding year of the company.","format":"integer"},"industry":{"type":["string","null"],"description":"Industry the company is associated with."},"employeesCount":{"type":["number","null"],"description":"Number of employees in the company.","format":"integer"},"country":{"type":["string","null"],"description":"Country where the company is based."},"locality":{"type":["string","null"],"description":"Locality or region where the company is based."},"_links":{"type":"array","items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["linkedin"]}}}}}}},"components/schemas/CustomerAverageValue":{"id":"components/schemas/CustomerAverageValue","kind":"json-schema","title":"CustomerAverageValue","data":{"type":"object","readOnly":true,"description":"Average customer value.","properties":{"currency":{"description":"Merchant's reporting currency.","$ref":"#/components/schemas/CurrencyCode"},"amount":{"x-type":"Money","x-label":"Average Value","x-sortable":true,"x-basic":true,"description":"Average amount of approved payments in the merchant's reporting currency.","type":"number","format":"double"},"amountUsd":{"description":"Average approved payment amount in USD.","type":"number","format":"double"}}}},"components/schemas/CustomerLifetimeRevenue":{"id":"components/schemas/CustomerLifetimeRevenue","kind":"json-schema","title":"CustomerLifetimeRevenue","data":{"type":"object","readOnly":true,"description":"Customer's lifetime revenue.","properties":{"currency":{"description":"Merchant's reporting currency.","$ref":"#/components/schemas/CurrencyCode"},"amount":{"x-type":"Money","x-label":"Lifetime Revenue","x-sortable":true,"x-basic":true,"description":"Revenue amount in the merchant's reporting currency.","type":"number","format":"double"},"amountUsd":{"description":"Revenue amount in USD.","type":"number","format":"double"}}}},"components/schemas/OrganizationId":{"id":"components/schemas/OrganizationId","kind":"json-schema","title":"OrganizationId","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique organization identifier."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An organization is an entity that represents a company."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain an organization ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":50,"example":"org_0YVDM8RC7GDADADSBSMW124JA8"}},"components/schemas/TaxNumber":{"id":"components/schemas/TaxNumber","kind":"json-schema","title":"TaxNumber","data":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","description":"Type of the tax number.","enum":["eu-vat","other"],"example":"eu-vat"},"value":{"type":"string","description":"Value of the tax number.","example":"GB980780684"},"isDefault":{"type":"boolean","description":"Determines if the tax number is selected as default to display on invoices.","example":true},"isValid":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines if the tax number passed the EU official "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://ec.europa.eu/taxation_customs/vies/#/vat-validation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIES validation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true,"readOnly":true}}}},"components/schemas/LeadSourceData":{"id":"components/schemas/LeadSourceData","kind":"json-schema","title":"LeadSourceData","data":{"type":"object","description":"Lead source information.","properties":{"medium":{"description":"Category of the lead source traffic.\nFor example, the medium could be organic search, Google ads, Display ads, and so on.","type":["string","null"],"maxLength":512},"source":{"description":"Domain, platform, or channel from which the lead source originates.","type":["string","null"],"maxLength":512},"campaign":{"description":"Campaign name of the lead source.","type":["string","null"],"maxLength":512},"term":{"description":"Term associated with a lead source.","type":["string","null"],"maxLength":512},"content":{"description":"Content contained in the lead source content.\nFor example, content could be graphics, video, and so on.","type":["string","null"],"maxLength":512},"affiliate":{"description":"Individual or entity that is affiliated with the lead source.","type":["string","null"],"maxLength":512},"subAffiliate":{"description":"Individual or entity that is associated with a lead source affiliate.\nIn other products, this field may also be referred to as sub ID or click ID in some.","type":["string","null"],"maxLength":512},"salesAgent":{"description":"Name of the sales agent associated with the lead source.","type":["string","null"],"maxLength":512},"clickId":{"description":"ID of the lead source click.\nThis value is passed in the ad click URL for tracking and campaign attribution.","type":["string","null"],"maxLength":512},"path":{"description":"URL from which the lead source originates.","type":["string","null"],"maxLength":512},"referrer":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lead source "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"referrer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"format":"uri","maxLength":2083,"example":"https://www.rebilly.com"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","customer"]}}}}}}},"components/schemas/Customer":{"id":"components/schemas/Customer","kind":"json-schema","title":"Customer","data":{"type":"object","description":"Customer information.","properties":{"id":{"type":"string","description":"ID of the customer.","readOnly":true,"example":"cus_0YV7DDSDD1C8DA64KHH2W33CPF","maxLength":50},"email":{"description":"Customer's email address.","type":["string","null"],"format":"email","readOnly":true,"x-sortable":true,"x-basic":true},"firstName":{"description":"Customer's first name.","type":["string","null"],"x-basic":true,"readOnly":true},"lastName":{"description":"Customer's last name.","type":["string","null"],"x-sortable":true,"x-basic":true,"readOnly":true},"websiteId":{"x-sortable":true,"allOf":[{"$ref":"#/components/schemas/WebsiteId"}]},"paymentToken":{"type":"string","writeOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Write-only payment token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If supplied, the token is converted into a payment instrument, and its ID is assigned to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"defaultPaymentInstrumentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this property overrides the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"defaultPaymentInstrumentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if both are supplied."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This token may only be used once before it expires."},"children":[]}]}]}]},"defaultPaymentInstrument":{"type":["object","null"],"description":"Default payment instrument of the customer.\n\nThe default payment instrument is used to automatically pay subscription renewals,\nand for transaction requests where a specific payment instrument is not provided.","readOnly":true,"required":["method","paymentInstrumentId"],"properties":{"method":{"$ref":"#/components/schemas/PaymentMethod"},"paymentInstrumentId":{"type":"string","description":"ID of the payment instrument.","maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"}}},"defaultPaymentInstrumentId":{"type":["string","null"],"description":"ID of the customer's default payment instrument.\n\nThe default payment instrument is used to automatically pay subscription renewals,\nand for transaction requests where a specific payment instrument is not provided.","maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N","writeOnly":true},"preferredPayoutInstrumentId":{"type":["string","null"],"description":"ID of the customer's preferred payment instrument for payouts.","maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N","default":null},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"primaryAddress":{"description":"Customer's primary address.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"company":{"$ref":"#/components/schemas/Company"},"averageValue":{"$ref":"#/components/schemas/CustomerAverageValue"},"paymentCount":{"x-label":"Payments","x-sortable":true,"x-basic":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of approved payments made by the customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments are the result of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions."},"children":[]}]}]}],"readOnly":true,"type":"integer"},"lastPaymentTime":{"x-label":"Last Payment","x-sortable":true,"x-basic":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the customer made their last approved payment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments are the result of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions."},"children":[]}]}]}],"type":["string","null"],"format":"date-time","readOnly":true},"lifetimeRevenue":{"$ref":"#/components/schemas/CustomerLifetimeRevenue"},"invoiceCount":{"x-sortable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of invoices issued to the customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is auto-incrementing."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the record relates to a lead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A lead is a customer who has not made a payment yet."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is greater than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the record relates to a customer."},"children":[]}]}]}],"readOnly":true,"type":"integer"},"tags":{"description":"List of customer tags.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"revision":{"description":"Number of times the customer's data has been modified.\n\nUse this value when analyzing webhook data to determine if a change must take precedence over the current representation.","type":"integer","readOnly":true},"hasFulfilledKyc":{"description":"Specifies if the customer has accepted and reviewed identity and address documents, or an accepted credit file document.","type":"boolean","readOnly":true},"organizationId":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/OrganizationId"}]},"locale":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language locale identifier in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc5646"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 5646"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"fr-FR","default":null},"taxNumbers":{"type":["array","null"],"description":"Tax numbers of the customer.","items":{"$ref":"#/components/schemas/TaxNumber"}},"leadSource":{"allOf":[{"$ref":"#/components/schemas/LeadSourceData"}],"writeOnly":true},"personId":{"type":["string","null"],"description":"ID of the associated person.","maxLength":50,"example":"prs_0YV7DDSDD1C8DA64KHH2W33CPF"},"notificationEmails":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email addresses for notification delivery in event-based email notifications."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you configure event-based email notifications, you can send to these addresses, the customer's primary email address, or another email address you specify."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/data-tables/manage-customer-information#manage-notification-emails"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage notification emails"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","format":"email"}},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","attachments","defaultPaymentInstrument","leadSource","website"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query string parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"defaultPaymentInstrument":{"type":"object"},"website":{"type":"object"},"leadSource":{"type":"object"}}}}}},"components/schemas/CustomerTimelineCustomEvent":{"id":"components/schemas/CustomerTimelineCustomEvent","kind":"json-schema","title":"CustomerTimelineCustomEvent","data":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"ID of the customer timeline custom event.","readOnly":true,"maxLength":50,"example":"tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC"},"name":{"description":"Name of the customer timeline custom event type.\nThis value must not conflict with any system event name.","type":"string","minLength":1,"maxLength":255},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/LeadSource":{"id":"components/schemas/LeadSource","kind":"json-schema","title":"LeadSource","data":{"allOf":[{"$ref":"#/components/schemas/LeadSourceData"},{"type":"object","properties":{"original":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LeadSourceData"}]}}}]}},"components/schemas/RedemptionCancelTimelineAction":{"id":"components/schemas/RedemptionCancelTimelineAction","kind":"json-schema","title":"RedemptionCancelTimelineAction","data":{"description":"Cancel redemption.","type":"object","readOnly":true,"properties":{"action":{"type":"string","enum":["redemption-cancel"]},"redemptionId":{"$ref":"#/components/schemas/ResourceId"}}}},"components/schemas/ResendEmailTimelineAction":{"id":"components/schemas/ResendEmailTimelineAction","kind":"json-schema","title":"ResendEmailTimelineAction","data":{"type":"object","description":"Resend email action.","readOnly":true,"properties":{"action":{"type":"string","enum":["resend-email"]},"messageId":{"$ref":"#/components/schemas/ResourceId"}}}},"components/schemas/RulesetRestoreTimelineAction":{"id":"components/schemas/RulesetRestoreTimelineAction","kind":"json-schema","title":"RulesetRestoreTimelineAction","data":{"type":"object","description":"Restore ruleset version.","readOnly":true,"properties":{"action":{"type":"string","enum":["ruleset-restore"]},"version":{"type":"integer","description":"Version of the ruleset to restore."}}}},"components/schemas/TimelineAction":{"id":"components/schemas/TimelineAction","kind":"json-schema","title":"TimelineAction","data":{"type":"object","discriminator":{"propertyName":"action","mapping":{"redemption-cancel":"#/components/schemas/RedemptionCancelTimelineAction","resend-email":"#/components/schemas/ResendEmailTimelineAction","ruleset-restore":"#/components/schemas/RulesetRestoreTimelineAction"}},"oneOf":[{"$ref":"#/components/schemas/RedemptionCancelTimelineAction"},{"$ref":"#/components/schemas/ResendEmailTimelineAction"},{"$ref":"#/components/schemas/RulesetRestoreTimelineAction"}]}},"components/schemas/TimelineTable":{"id":"components/schemas/TimelineTable","kind":"json-schema","title":"TimelineTable","data":{"type":"object","description":"Additional timeline message information.","discriminator":{"propertyName":"type","mapping":{"three-columns":"#/components/schemas/ThreeColumnsTimelineTable","two-columns":"#/components/schemas/TwoColumnsTimelineTable","one-column":"#/components/schemas/OneColumnTimelineTable","list":"#/components/schemas/ListTimelineTable"}},"properties":{"type":{"type":"string","enum":["list","one-columns","two-columns","three-columns"]},"title":{"type":"string","description":"Data table title."},"footer":{"type":"string","description":"Data table footer."}}}},"components/schemas/ThreeColumnsTimelineTable":{"id":"components/schemas/ThreeColumnsTimelineTable","kind":"json-schema","title":"ThreeColumnsTimelineTable","data":{"allOf":[{"$ref":"#/components/schemas/TimelineTable"},{"type":"object","properties":{"data":{"type":"array","description":"Table data.\nEach array element represents a table row.","items":{"type":"object","properties":{"attribute":{"type":"string"},"previousValue":{"type":["string","integer","number","boolean"]},"newValue":{"type":["string","integer","number","boolean"]}},"example":{"attribute":"Descriptor","previousValue":"test.com","newValue":"new-test.com"}}}}}]}},"components/schemas/TwoColumnsTimelineTable":{"id":"components/schemas/TwoColumnsTimelineTable","kind":"json-schema","title":"TwoColumnsTimelineTable","data":{"allOf":[{"$ref":"#/components/schemas/TimelineTable"},{"type":"object","properties":{"data":{"type":"array","description":"Table data.\nEach array element represents a table row.","items":{"type":"object","properties":{"attribute":{"type":"string"},"value":{"type":["string","integer","number","boolean"]}},"example":{"attribute":"Who","value":"John Doe"}}}}}]}},"components/schemas/OneColumnTimelineTable":{"id":"components/schemas/OneColumnTimelineTable","kind":"json-schema","title":"OneColumnTimelineTable","data":{"allOf":[{"$ref":"#/components/schemas/TimelineTable"},{"type":"object","properties":{"data":{"type":"array","description":"Table data.\nEach array element represents a table row.","items":{"type":"object","properties":{"attribute":{"type":"string"},"value":{"type":["string","integer","number","boolean"]}},"example":{"attribute":"Who","value":"John Doe"}}}}}]}},"components/schemas/ListTimelineTable":{"id":"components/schemas/ListTimelineTable","kind":"json-schema","title":"ListTimelineTable","data":{"allOf":[{"$ref":"#/components/schemas/TimelineTable"},{"type":"object","properties":{"data":{"type":"array","description":"Table data.\nEach array element represents a table row.","items":{"type":"string"}}}}]}},"components/schemas/TimelineExtraData":{"id":"components/schemas/TimelineExtraData","kind":"json-schema","title":"TimelineExtraData","data":{"type":"object","description":"Additional data.","readOnly":true,"properties":{"actions":{"description":"Actions available for a timeline message.\nIf no actions are available, this field is empty.","type":"array","minItems":0,"items":{"$ref":"#/components/schemas/TimelineAction"}},"tables":{"description":"Table data that is attached to the timeline message.","type":"array","minItems":0,"items":{"$ref":"#/components/schemas/TimelineTable"}},"author":{"type":"object","description":"Author of the timeline message.","properties":{"userFullName":{"description":"Full name of the author.","type":"string"},"userId":{"description":"ID of the author.","type":"string","maxLength":50,"example":"usr_0YVCEENYJ3D7Q9EN6BN16HA0G4"}}},"mentions":{"description":"User mentions, or tags, in a timeline.","type":"object","additionalProperties":{"type":"string"},"example":{"@test@mail.com":"userId-1"}},"links":{"description":"Links that are attached to a timeline message.","type":"array","items":{"type":"object","properties":{"resourceType":{"type":"string","enum":["kyc-document","invoice","subscription","transaction","email-message","dispute","coupon","external"]},"resourceId":{"$ref":"#/components/schemas/ResourceId"},"placeholder":{"type":"string","example":"KYC document"},"externalUrl":{"type":"string","example":"http://example.com"}}}}}}},"components/schemas/ServerTimestamp":{"id":"components/schemas/ServerTimestamp","kind":"json-schema","title":"ServerTimestamp","data":{"type":"string","description":"Read-only timestamp in ISO 8601 date-time format.","format":"date-time","readOnly":true}},"components/schemas/CustomerTimeline":{"id":"components/schemas/CustomerTimeline","kind":"json-schema","title":"CustomerTimeline","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the customer timeline custom event.","readOnly":true,"maxLength":50,"example":"tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC"},"type":{"description":"Type of timeline message.","type":"string","enum":["account-password-reset-requested","account-verification-requested","aml-list-was-possibly-matched","deposit-request-completed","deposit-request-created","deposit-request-expired","deposit-request-started","coupon-applied","coupon-redeemed","coupon-redemption-canceled","custom-event","custom-event-processed","custom-fields-changed","customer-bank-account-blocked","customer-blocked","customer-comment-created","customer-created","customer-merged","customer-payment-card-blocked","customer-requested-otp","customer-tagged","customer-untagged","default-payment-instrument-changed","email-message-sent","experian-check-performed","invoice-abandoned","invoice-created","invoice-disputed","invoice-issued","invoice-paid","invoice-partially-paid","invoice-partially-refunded","invoice-past-due","invoice-refunded","invoice-reissued","invoice-revenue-recognized","invoice-voided","kyc-document-accepted","kyc-document-created","kyc-document-modified","kyc-document-rejected","kyc-document-reviewed","kyc-request-fulfilled","lead-source-changed","order-activated","order-canceled","order-churned","order-completed","order-created","order-downgraded","order-paid-early","order-reactivated","order-renewed","order-trial-ended","order-upgraded","payment-card-expiration-was-modified","payment-card-expired","payment-instrument-created","payment-instrument-deactivated","primary-address-changed","quickbooks-customer-created","quickbooks-customer-task-failed","quote-canceled","quote-created","quote-expired","quote-issued","quote-order-attached","quote-recalled","quote-rejected","quote-updated","refund-was-reflected-in-invoices","subscription-paused","subscription-resumed","subscription-trial-end-changed","transaction-abandoned","transaction-amount-discrepancy-found","transaction-approved","transaction-canceled","transaction-declined","transaction-discrepancy-found","transaction-disputed","transaction-reconciled","transaction-partially-refunded","transaction-refunded","transaction-voided","transaction-waiting-gateway"]},"customEventType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timeline custom event type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom-event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value must be defined using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/customers-timeline/postcustomertimelinecustomeventtype"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create customer timeline custom event type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}],"type":["string","null"],"minLength":1,"maxLength":255},"customData":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timeline custom event data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom-event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transforms to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extraData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" two-column table in response."},"children":[]}]}]}],"type":"object","writeOnly":true,"example":{"customAttribute":"customValue","otherAttribute":"otherValue"}},"triggeredBy":{"description":"Specifies who, or what, triggered the timeline event.","type":"string","readOnly":true,"enum":["rebilly","app","direct-api"]},"message":{"description":"Detailed message description.","type":"string"},"extraData":{"$ref":"#/components/schemas/TimelineExtraData"},"occurredTime":{"description":"Date and time when the timeline message occurred.","$ref":"#/components/schemas/ServerTimestamp"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/CustomerCreditBalance":{"id":"components/schemas/CustomerCreditBalance","kind":"json-schema","title":"CustomerCreditBalance","data":{"type":"object","required":["balances"],"properties":{"balances":{"description":"Customer credit balances grouped by currency.","readOnly":true,"type":"array","items":{"type":"object","required":["currency","unallocatedAmount"],"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"unallocatedAmount":{"description":"Sum of unallocated credit memo amounts for the currency.","readOnly":true,"type":"number","format":"double","x-type":"Money","x-currency-field":"currency"}}}}}}},"components/schemas/Dispute":{"id":"components/schemas/Dispute","kind":"json-schema","title":"Dispute","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the dispute.","readOnly":true,"maxLength":50,"example":"dp_0YVCE8J5F2DE58FV0S8YASW4HK"},"customerId":{"description":"ID of the customer who is disputing a transaction.","type":["string","null"],"readOnly":true,"maxLength":50,"example":"cus_0YV7DDSDD1C8DA64KHH2W33CPF"},"transactionId":{"description":"ID of the disputed transaction.","type":["string","null"],"maxLength":50,"example":"txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"description":"Dispute amount.","type":"number","format":"double"},"acquirerReferenceNumber":{"description":"Acquirer reference number for the dispute.","type":["string","null"]},"caseId":{"description":"Case ID of the dispute.","type":["string","null"]},"reasonCode":{"description":"Code used in the chargeback that describes the reason for the dispute.","type":["string","null"],"maxLength":255},"reasonDescription":{"description":"Description of the reason for the dispute.","type":["string","null"],"maxLength":512,"readOnly":true},"category":{"description":"Category of dispute.","type":"string","readOnly":true,"enum":["fraud","authorization","processing-errors","consumer-disputes","uncategorized","bank-return"]},"type":{"description":"Type of dispute.","type":"string","enum":["information-request","first-chargeback","second-chargeback","arbitration","fraud","ethoca-alert","verifi-alert","bank-return","paypal-claim","representment","inquiry","forced-refund","collaboration"]},"status":{"description":"Status of the dispute.","type":"string","enum":["response-needed","under-review","forfeited","won","lost","unknown"]},"postedTime":{"description":"Date and time when the dispute is posted.","type":"string","format":"date-time"},"deadlineTime":{"description":"Latest date and time by when a merchant must submit a representment for a dispute.\nIf the deadline is missed, the merchant loses the dispute.","type":["string","null"],"format":"date-time"},"rawResponse":{"description":"Raw response from the payment gateway that processed the disputed transaction.","type":["string","null"],"readOnly":true},"resolvedTime":{"type":["string","null"],"format":"date-time","description":"Date and time when the dispute is resolved.","readOnly":true},"source":{"description":"Source of the dispute.","type":["string","null"],"readOnly":true,"enum":[null,"api","manual","sftp","webhook"]},"revision":{"description":"Number of times the dispute data has been modified.\n\nUse the revision number when analyzing webhook data to\ndetermine if a change should take precedence over the current\nrepresentation.","type":"integer","readOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","transaction","customer","attachments"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"transaction":{"type":"object"},"customer":{"type":"object"}}}}}},"components/schemas/TransactionId":{"id":"components/schemas/TransactionId","kind":"json-schema","title":"TransactionId","data":{"type":"string","description":"ID of the transaction.","maxLength":50,"example":"txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"}},"components/schemas/File":{"id":"components/schemas/File","kind":"json-schema","title":"File","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the file.","readOnly":true,"maxLength":50,"example":"file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"},"name":{"description":"Original file name.","type":"string","maxLength":255},"extension":{"description":"File extension.","type":"string"},"description":{"description":"Description of the file.","type":"string","maxLength":255},"sourceType":{"description":"Source of the file.","type":["string","null"],"enum":["upload","camera","organization-export","organization-closure-export",null],"example":"upload"},"tags":{"description":"List of tags associated with the file.","type":"array","items":{"type":"string"}},"mime":{"description":"MIME type of the file.","type":"string","readOnly":true,"enum":["image/png","image/jpeg","image/gif","application/pdf","application/json","application/zip","text/csv"]},"size":{"description":"File size, in bytes.","type":"integer","readOnly":true},"width":{"description":"Width of the image.\nThis field is applicable to images only.","type":["integer","null"],"readOnly":true},"height":{"description":"Height of the image.\nThis field is applicable to images only.","type":["integer","null"],"readOnly":true},"sha1":{"description":"Hash sum of the file.","type":"string","readOnly":true},"exifData":{"description":"Collection of EXIF tags contained in the image metadata.\nThis field is applicable to images only.","type":["object","null"],"readOnly":true,"example":{"FileSize":120,"Software":"GIMP 2.4.5"}},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"isPublic":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the file is available publicly without authentication."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the permalink in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section contains the public URL."},"children":[]}]}]}],"type":"boolean"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","download","signedLink","permalink"]}}}}}}},"components/schemas/FileCreateFromInline":{"id":"components/schemas/FileCreateFromInline","kind":"json-schema","title":"FileCreateFromInline","data":{"type":"object","required":["file"],"properties":{"file":{"description":"File in base64 encoded format.","type":"string","example":"R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs="},"isPublic":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the file is available publicly without authentication."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the permalink in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section contains the public URL."},"children":[]}]}]}],"type":"boolean","example":false},"name":{"description":"File name used for downloading.","type":"string","maxLength":255,"example":"logo.png"},"description":{"description":"Description of the file.","type":"string","maxLength":255,"example":"My file description"},"sourceType":{"description":"Source of the file.","type":["string","null"],"enum":["upload","camera","organization-export","organization-closure-export",null],"example":"upload"},"tags":{"description":"List of tags associated with the file.","type":"array","items":{"type":"string"},"example":["test","tags"]}}}},"components/schemas/FileCreateFromUrl":{"id":"components/schemas/FileCreateFromUrl","kind":"json-schema","title":"FileCreateFromUrl","data":{"type":"object","required":["url"],"properties":{"url":{"description":"URL of the file to upload.","type":"string","example":"https://app.rebilly.com/static/gateways/Stripe.png"},"isPublic":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the file is available publicly without authentication."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the permalink in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section contains the public URL."},"children":[]}]}]}],"type":"boolean","example":false},"name":{"description":"File name used for downloading.","type":"string","maxLength":255,"example":"logo.png"},"description":{"description":"Description of the file.","type":"string","maxLength":255,"example":"My file description"},"sourceType":{"description":"Source of the file.","type":["string","null"],"enum":["upload","camera","organization-export","organization-closure-export",null],"example":"upload"},"tags":{"description":"List of tags associated with the file.","type":"array","items":{"type":"string"},"example":["test","tags"]}}}},"components/schemas/ManualShipping":{"id":"components/schemas/ManualShipping","kind":"json-schema","title":"ManualShipping","data":{"description":"Manually set shipping amount.","type":"object","required":["amount","calculator"],"properties":{"amount":{"x-type":"Money","type":"number","format":"double","description":"Shipping amount."},"calculator":{"description":"Shipping calculator.","type":"string","enum":["manual"]}}}},"components/schemas/RebillyShipping":{"id":"components/schemas/RebillyShipping","kind":"json-schema","title":"RebillyShipping","data":{"description":"Rebilly-based shipping which is calculated by shipping rates.","type":"object","required":["calculator"],"properties":{"calculator":{"description":"Shipping calculator.","type":"string","enum":["rebilly"]},"rateId":{"description":"ID of the shipping rate.\nIf this value is not set,\nthe cheapest applicable shipping rate is used.","type":["string","null"],"maxLength":50,"example":"shipping-123-456"},"amount":{"type":"number","format":"double","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping amount which is calculated from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/shipping-rates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping rates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/Shipping":{"id":"components/schemas/Shipping","kind":"json-schema","title":"Shipping","data":{"description":"Shipping settings.","type":"object","discriminator":{"propertyName":"calculator","mapping":{"manual":"#/components/schemas/ManualShipping","rebilly":"#/components/schemas/RebillyShipping"}},"oneOf":[{"$ref":"#/components/schemas/ManualShipping"},{"$ref":"#/components/schemas/RebillyShipping"}]}},"components/schemas/TaxItem":{"id":"components/schemas/TaxItem","kind":"json-schema","title":"TaxItem","data":{"type":"object","required":["amount","description"],"properties":{"amount":{"description":"Amount of the tax.","type":"number","format":"double"},"description":{"type":"string","description":"Description of the tax."},"rate":{"description":"Overall sales tax rate which includes state, county, city and district tax.","type":["number","null"],"format":"double","readOnly":true},"stateAmount":{"description":"Amount of sales tax to collect for the state.","type":["number","null"],"format":"double","example":0.94,"readOnly":true},"countyAmount":{"description":"Amount of sales tax to collect for the county.","type":["number","null"],"format":"double","example":0.04,"readOnly":true},"cityAmount":{"description":"Amount of sales tax to collect for the city.","type":["number","null"],"format":"double","example":0,"readOnly":true},"specialDistrictAmount":{"description":"Amount of sales tax to collect for the special district.","type":["number","null"],"format":"double","example":0.38,"readOnly":true},"stateRate":{"description":"State sales tax rate for given location.","type":["number","null"],"format":"double","readOnly":true},"countyRate":{"description":"County sales tax rate for given location.","type":["number","null"],"format":"double","readOnly":true},"cityRate":{"description":"City sales tax rate for given location.","type":["number","null"],"format":"double","readOnly":true},"specialDistrictRate":{"description":"Special district sales tax rate for given location.","type":["number","null"],"format":"double","readOnly":true},"jurisdictions":{"description":"Jurisdiction names for the invoice.","type":["object","null"],"readOnly":true,"properties":{"country":{"description":"Two-letter ISO country code for the provided location.","type":["string","null"],"example":"US","readOnly":true},"state":{"description":"Postal abbreviated state name for the provided location.","type":["string","null"],"example":"CA","readOnly":true},"county":{"description":"County name for the provided location.","type":["string","null"],"example":"LOS ANGELES","readOnly":true},"city":{"description":"City name for the provided location.","type":["string","null"],"example":"LOS ANGELES","readOnly":true}}}}}},"components/schemas/ManualTax":{"id":"components/schemas/ManualTax","kind":"json-schema","title":"ManualTax","data":{"type":"object","description":"Manual tax calculator.","required":["calculator","items"],"properties":{"calculator":{"description":"Type of tax calculator.","type":"string","enum":["manual"]},"amount":{"type":"number","format":"double","x-type":"Money","x-sortable":true,"description":"Total amount of taxes.","readOnly":true},"items":{"type":"array","description":"Taxes applied.","items":{"$ref":"#/components/schemas/TaxItem"}}}}},"components/schemas/RebillyTaxJarTax":{"id":"components/schemas/RebillyTaxJarTax","kind":"json-schema","title":"RebillyTaxJarTax","data":{"type":"object","description":"TaxJar tax calculator.","required":["calculator"],"properties":{"calculator":{"description":"Type of tax calculator.","type":"string","enum":["rebilly-taxjar"]},"amount":{"type":"number","format":"double","x-type":"Money","x-sortable":true,"description":"Total amount of taxes.","readOnly":true},"items":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Taxes applied and calculated based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCategoryId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the related product."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/TaxItem"}}}}},"components/schemas/RebillyAvalaraTax":{"id":"components/schemas/RebillyAvalaraTax","kind":"json-schema","title":"RebillyAvalaraTax","data":{"type":"object","description":"Avalara tax calculator.","required":["calculator"],"properties":{"calculator":{"description":"Type of tax calculator.","type":"string","enum":["rebilly-avalara"]},"amount":{"type":"number","format":"double","x-type":"Money","x-sortable":true,"description":"Total amount of taxes.","readOnly":true},"items":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Taxes applied and calculated based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxCategoryId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the related product."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/TaxItem"}}}}},"components/schemas/Taxes":{"id":"components/schemas/Taxes","kind":"json-schema","title":"Taxes","data":{"description":"Taxes.","type":"object","discriminator":{"propertyName":"calculator","mapping":{"manual":"#/components/schemas/ManualTax","rebilly-taxjar":"#/components/schemas/RebillyTaxJarTax","rebilly-avalara":"#/components/schemas/RebillyAvalaraTax"}},"oneOf":[{"$ref":"#/components/schemas/ManualTax"},{"$ref":"#/components/schemas/RebillyTaxJarTax"},{"$ref":"#/components/schemas/RebillyAvalaraTax"}]}},"components/schemas/InvoiceItem":{"id":"components/schemas/InvoiceItem","kind":"json-schema","title":"InvoiceItem","data":{"type":"object","required":["type","unitPrice"],"properties":{"id":{"type":"string","description":"ID of the invoice item.","readOnly":true,"maxLength":50,"example":"ii_0YVFDEQS2KCFTBN9HXWJFY55GV"},"type":{"description":"Type of invoice item.","type":"string","x-basic":true,"enum":["debit","credit"]},"description":{"description":"Description of the invoice item.","type":"string","maxLength":1000},"unitPrice":{"description":"Unit price of the invoice item.","type":"number","format":"double"},"quantity":{"description":"Quantity of the invoice item.","type":"integer"},"price":{"description":"Total price of the invoice item.","type":"number","format":"double","readOnly":true},"productId":{"type":["string","null"],"description":"ID of the product.","maxLength":50,"example":"prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"},"planId":{"type":["string","null"],"description":"ID of the plan.","maxLength":50,"readOnly":true,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"},"subscriptionId":{"type":["string","null"],"description":"ID of the order.","maxLength":50,"readOnly":true,"example":"sub_01HRF27SATGE4Z6PBJE6PD8328"},"periodStartTime":{"description":"Date and time when the billing period starts.","type":["string","null"],"format":"date-time"},"periodEndTime":{"description":"Date and time when the billing period ends.","type":["string","null"],"format":"date-time"},"periodNumber":{"description":"Billing period number that is associated with the invoice item.\nFor example, an invoice item for a service is included in billing period number 3.\nThe invoice item is only applied to billing period number 3.","type":["integer","null"]},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"tax":{"description":"Invoice item tax.","readOnly":true,"oneOf":[{"$ref":"#/components/schemas/TaxItem"},{"type":"null"}]},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","product","subscription","plan"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"product":{"type":"object"},"plan":{"type":"object"}}}}}},"components/schemas/CreditMemoInvoiceAllocation":{"id":"components/schemas/CreditMemoInvoiceAllocation","kind":"json-schema","title":"CreditMemoInvoiceAllocation","data":{"type":"object","properties":{"invoiceId":{"type":"string","description":"ID of invoice to which the credit memo is allocated.","maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of credit that is allocated from the credit memo to the invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is not supplied or exceeds the unused amount of the credit memo or the invoice due amount, the lesser of the following two values is used:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unused amount of the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice due amount."},"children":[]}]}]}]}],"type":"number","format":"double"},"currency":{"readOnly":true,"$ref":"#/components/schemas/CurrencyCode"},"createdTime":{"description":"Date and time at which a credit memo is allocated.","$ref":"#/components/schemas/ServerTimestamp"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"}}}},"components/schemas/GatewayName":{"id":"components/schemas/GatewayName","kind":"json-schema","title":"GatewayName","data":{"description":"Payment gateway name.","type":["string","null"],"enum":["A1Gateway","ACI","Adyen","Aera","Aircash","Airpay","Airwallex","AsiaPay","AmazonPay","AmexVPC","Antom","ApcoPay","AsiaPaymentGateway","AstroPayCard","AuthorizeNet","Awepay","Bambora","BankSEND","BitPay","BlueSnap","BraintreePayments","Buckaroo","BVNK","Cardknox","Cashflows","CASHlib","Cashterminal","CashToCode","CauriPayment","Cayan","CCAvenue","Chase","CheckoutCom","Chillstock","Circle","Citadel","Clearhaus","Cleo","CODVoucher","Coinbase","CoinGate","CoinPayments","Conekta","Coppr","Credorax","Cryptomus","Cryptonator","CyberSource","DataCash","Dengi","Dimoco","Directa24","dLocal","Dragonphoenix","Dropayment","EasyPayDirect","EBANX","ecoPayz","ecoPayzTurkey","EcorePay","Elavon","Euteller","eMerchantPay","EMS","ePay","EPG","EPro","Ezeebill","eZeeWallet","ezyEFT","FasterPay","Finrax","Flexepin","FinTecSystems","FundSend","Forte","gate2way","GET","Gigadat","GlobalOnePay","GoCardless","Gooney","Gpaysafe","Greenbox","HiPay","iCashOne","iCanPay","ICEPAY","iCheque","iDebit","Ilixium","IMerchant","Ingenico","INOVAPAY","Inovio","Intuit","InstaDebit","IpayOptions","Isx","JetPay","Jeton","JPMOrbital","Khelocard","Klarna","Konnektive","Kushki","LaCore","Limepay","Loonio","loonie","LPG","MaxiCash","MercadoPago","MiFinity","Mollie","MobilePay","Moneris","Monolo","MonRem","MtaPay","MuchBetter","MuchBetterGateway","MyFatoorah","Naewe","Neosurf","Netbanking","Neteller","NGenius","NinjaWallet","NMI","NordikCoin","NOWPayments","NuaPay","OchaPay","OmniMatrix","Onlineueberweisen","OnRamp","Orbital","Pagadito","Pagsmile","Panamerican","ParamountCommerce","ParamountEft","ParamountInterac","PandaGateway","Pay4Fun","Paybilt","PayCash","Paycly","PayClub","PayCom","PayEcards","Payeezy","Payflow","PayGlocal","Paynote","PaymentAsia","PaymenTechnologies","PaymentsOS","Paymero","PayPal","Payper","Payr","PayRedeem","PayRetailers","Paysafe","Paysafecard","Paysafecash","PayTabs","PayU","PayULatam","Payvision","PayXpert","PharosPayments","Piastrix","Pin4Pay","Plugnpay","PostFinance","Powertranz","PPRO","Prosa","PSiGate","Quickpay","Rapyd","Realex","Realtime","Redsys","Rotessa","RPN","Safecharge","SaltarPay","Sagepay","SeamlessChex","SecureTrading","SecurionPay","Skrill","SmartInvoice","SMSVoucher","Sofort","SparkPay","Splitit","StaticGateway","STPMexico","Stripe","Tabby","Telr","TestProcessor","ToditoCash","Triple000","Truevo","TrustsPay","Trustly","TWINT","Txn","Unlimit","UPayCard","USAePay","VantivLitle","vegaaH","VCreditos","VegaWallet","Viva","Wallet88","Walpay","WesternUnion","Wirecard","WorldlineAtosFrankfurt","Worldpay","XPay","Zimpler","Zotapay"]}},"components/schemas/AcquirerName":{"id":"components/schemas/AcquirerName","kind":"json-schema","title":"AcquirerName","data":{"description":"Acquirer name.","type":["string","null"],"enum":["Adyen","ACI","Aera","Alipay","AIB","Aircash","Airpay","AmazonPay","ApcoPay","AsiaPaymentGateway","AstroPay Card","Awepay","Ipay Options","B+S","Bambora","BitPay","Bank of America","Bank of Moscow","Bank of Rebilly","Bank One","BankSEND","BMO Harris Bank","Borgun","BraintreePayments","Buckaroo","BVNK","Cardknox","CASHlib","Cashterminal","CashToCode","Catalunya Caixa","CCAvenue","Chase","CheckoutCom","Chillstock","ChinaUnionPay","CIM","Circle","Citadel","Clearhaus","Cleo","CODVoucher","Coinbase","CoinGate","CoinPayments","Conekta","Coppr","Credorax","Cryptonator","CyberSource","Dimoco","dLocal","Dragonphoenix","Dropayment","EasyPayDirect","EBANX","ecoPayz","EcorePay","Elavon","EMS","ePay","EPG","Euteller","Ezeebill","eZeeWallet","ezyEFT","Fifth Third Bank","Finrax","First Data Buypass","First Data Nashville","First Data North","First Data Omaha","FinTecSystems","Flexepin","Forte","FundSend","gate2way","Gigadat","Global East","Gooney","Gpaysafe","Heartland","HiPay","HSBC","iCashOne","iCanPay","ICEPAY","iCheque","Ilixium","Ingenico","INOVAPAY","Intuit","Isx","Jeton","JPMOrbital","Khelocard","Klarna","Konnektive","Kushki","Limepay","Loonio","loonie","LPG","Masapay","MaxiCash","MercadoPago","Merrick","Mission Valley Bank","MiFinity","MobilePay","Moneris","Monolo","MonRem","MuchBetter","MuchBetterGateway","MyFatoorah","NATWEST","Neosurf","Netbanking","Neteller","NinjaWallet","NMI","NordikCoin","NOWPayments","NuaPay","Nuvei","OchaPay","OmniMatrix","Onlineueberweisen","OnRamp","Orbital","Other","Panamerican","Panda Bank","Paramount","ParamountCommerce","ParamountEft","ParamountInterac","Pay4fun","Paybilt","PayCash","PayClub","PayEcards","PayGlocal","PaymentAsia","PaymenTechnologies","PaymentsOS","Paymero","Paynetics","PayPal","Payper","Payr","PayRedeem","PayRetailers","PayTabs","PayU","PayULatam","Payvision","PharosPayments","Piastrix","Pin4Pay","Peoples Trust Company","PostFinance","PPRO","Privatbank","Prosa","PSiGate","QQPay","Rapyd","RBC","RBS WorldPay","RealTime","Rotessa","Safecharge","SaltarPay","SecureTrading","SecurionPay","Skrill","SmartInvoice","SMSVoucher","Sofort","SparkPay","State Bank of Mauritius","STPMexico","Stripe","Tabby","TBI","Telr","TestProcessor","ToditoCash","Triple000","Truevo","Trustly","TrustPay","TrustsPay","TSYS","TWINT","Txn","UPayCard","Vantiv","VCreditos","VegaWallet","VoicePay","Wallet88","WeChat Pay","Wells Fargo","Wing Hang Bank","Wirecard","WorldPay","XPay","Zimpler","Zotapay"]}},"components/schemas/VaultedInstrument":{"id":"components/schemas/VaultedInstrument","kind":"json-schema","title":"Vaulted payment instrument","data":{"title":"Vaulted payment instrument","description":"Vaulted payment instrument.\n\nTo use this payment instrument for automatic subscription renewals,\nand for transactions when no specific payment instrument is provided by the user,\nset this as the default payment instrument.","required":["method","paymentInstrumentId"],"properties":{"method":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method supported vault."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/payment-instruments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["payment-card","ach","paypal"]},"paymentInstrumentId":{"type":"string","description":"ID of the payment instrument.","maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"}}}},"components/schemas/AlternativePaymentInstrument":{"id":"components/schemas/AlternativePaymentInstrument","kind":"json-schema","title":"Alternative instrument","data":{"title":"Alternative instrument","description":"Alternative payment method instrument.\n\nTo use this payment instrument for automatic subscription renewals,\nand for transactions when no specific payment instrument is provided by the user,\nset this as the default payment instrument.","type":"object","required":["method"],"properties":{"method":{"allOf":[{"$ref":"#/components/schemas/PaymentMethod"},{"not":{"enum":["payment-card","ach","paypal","cash","check"]}}]},"paymentInstrumentId":{"type":"string","description":"ID of the payment instrument.","maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"},"reference":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bank-transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment method."},"children":[]}]}]}],"type":["string","null"]}}}},"components/schemas/CashInstrument":{"id":"components/schemas/CashInstrument","kind":"json-schema","title":"Cash","data":{"title":"Cash","description":"Cash payment instrument object.\n\nTo use this payment instrument for automatic subscription renewals,\nand for transactions when no specific payment instrument is provided by the user,\nset this as the default payment instrument.","type":"object","required":["method"],"properties":{"method":{"type":"string","enum":["cash"]},"receivedBy":{"description":"Individual or entity that received the payment.","type":"string"}}}},"components/schemas/CheckInstrument":{"id":"components/schemas/CheckInstrument","kind":"json-schema","title":"Check","data":{"title":"Check","description":"Check payment instrument object.\n\nTo use this payment instrument for automatic subscription renewals,\nand for transactions when no specific payment instrument is provided by the user,\nset this as the default payment instrument.","type":"object","required":["method"],"properties":{"method":{"type":"string","enum":["check"]},"reference":{"description":"Reference data.","type":"string"}}}},"components/schemas/MoneyAmount":{"id":"components/schemas/MoneyAmount","kind":"json-schema","title":"MoneyAmount","data":{"type":"number","format":"double","example":10,"x-type":"Money"}},"components/schemas/Money":{"id":"components/schemas/Money","kind":"json-schema","title":"Money","data":{"type":"object","required":["amount","currency"],"properties":{"amount":{"$ref":"#/components/schemas/MoneyAmount"},"currency":{"$ref":"#/components/schemas/CurrencyCode"}}}},"components/schemas/HttpHeaders":{"id":"components/schemas/HttpHeaders","kind":"json-schema","title":"HttpHeaders","data":{"type":"object","description":"HTTP headers.","additionalProperties":{"type":"string"},"example":{"Content-Type":"application/json","Accept":"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"},"x-is-free-form":true}},"components/schemas/RiskMetadata":{"id":"components/schemas/RiskMetadata","kind":"json-schema","title":"Risk metadata","data":{"type":"object","title":"Risk metadata","description":"Risk metadata used for 3D Secure and risk scoring.","properties":{"ipAddress":{"description":"Customer's IP address.","type":["string","null"],"format":"ipv4 or ipv6","example":"93.92.91.90"},"fingerprint":{"description":"Customer's device fingerprint.\nA device fingerprint is a unique token that is used to identify the customer.\nThe device fingerprint is generated based on device attributes, such as: hardware,\nsoftware, IP address, language, browser, and more.","type":["string","null"],"maxLength":50,"example":"pIUt3xbgX3l9g3YDiLbx"},"httpHeaders":{"oneOf":[{"$ref":"#/components/schemas/HttpHeaders"},{"type":"null"}]},"browserData":{"type":["object","null"],"description":"Browser data used for 3D Secure and risk scoring.","required":["colorDepth","isJavaEnabled","language","screenWidth","screenHeight","timeZoneOffset"],"properties":{"colorDepth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Browser color depth in bits per pixel."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is obtained using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"screen.colorDepth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}],"type":"integer","minimum":1,"maximum":48,"example":24},"isJavaEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if Java is enabled in a browser."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is obtained from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.javaEnabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}],"type":"boolean"},"language":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Browser language settings."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is obtained from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}],"type":"string","example":"en-US","maxLength":8},"screenWidth":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Width of the browser screen."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is obtained from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"screen.width"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}],"type":"integer","minimum":0,"maximum":65535,"example":1920},"screenHeight":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Height of the browser screen."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is obtained from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"screen.height"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}],"type":"integer","minimum":0,"maximum":65535,"example":1080},"timeZoneOffset":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Browser time zone offset in minutes from UTC."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A positive offset indicates that the local time is behind UTC."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A negative offset indicates that the local time is ahead of UTC."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can find this value using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(new Date()).getTimezoneOffset()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}],"type":"integer","minimum":-1410,"maximum":1410,"example":300},"isAdBlockEnabled":{"description":"Specifies if the usage of ad block has been detected in the browser.","type":"boolean"}}},"extraData":{"type":["object","null"],"description":"Third-party data used for risk scoring.","properties":{"kountFraudSessionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alpha-numeric "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fraudSessionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as provided by the Kount SDK."},"children":[]}]}]}],"type":"string","minimum":10,"maximum":32,"example":"abcdefg12345abababab123456789012"},"payPalMerchantSessionId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayPal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MerchantSessionID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as generated by the PayPal Fraudnet SDK."},"children":[]}]}]}],"type":"string","minimum":1,"maximum":64,"example":"dd65ratxc5qv15iph3vyoq7l6davuowa"},"threatMetrixSessionId":{"description":"Temporary identifier that is unique to the visitor session and passed to ThreatMetrix.","pattern":"[a-zA-Z0-9_-]+","type":"string","minimum":1,"maximum":128,"example":"dd65ratxc5qv15iph3vyoq7l6davuowadd65ratxc5qv15iph3vyoq7l6davuowa"}}},"isProxy":{"description":"Specifies if the customer's IP address is related to a proxy.","type":"boolean","readOnly":true},"isVpn":{"description":"Specifies if the customer's IP address is related to a VPN.","type":"boolean","readOnly":true},"isTor":{"description":"Specifies if the customer's IP address is related to TOR.","type":"boolean","readOnly":true},"isHosting":{"description":"Specifies if the customer's IP address is related to hosting.","type":"boolean","readOnly":true},"hostingName":{"description":"Name of the data center or hosting provider, if available.","type":["string","null"],"readOnly":true},"isp":{"description":"Internet Service Provider (ISP) name, if available.","type":["string","null"],"readOnly":true},"country":{"description":"Country ISO Alpha-2 code of the specified IP address.","maxLength":2,"type":["string","null"],"readOnly":true,"example":"US"},"region":{"description":"Region of the specified IP address.","type":["string","null"],"readOnly":true,"example":"NY"},"city":{"description":"City of the specified IP address.","type":["string","null"],"readOnly":true,"example":"New York"},"latitude":{"description":"Latitude of the specified IP address.","type":"number","format":"double","readOnly":true},"longitude":{"description":"Longitude of the specified IP address.","type":["number","null"],"format":"double","readOnly":true},"postalCode":{"description":"Postal code of the specified IP address.","type":["string","null"],"maxLength":10,"readOnly":true},"timeZone":{"description":"Time zone of the specified IP address.","type":["string","null"],"readOnly":true,"example":"America/New_York"},"accuracyRadius":{"description":"Accuracy radius of the specified IP address, in kilometers.","type":["integer","null"],"readOnly":true},"distance":{"description":"Distance between the customer's IP address and the billing address geolocation, in kilometers.","type":["integer","null"],"readOnly":true},"hasMismatchedBillingAddressCountry":{"description":"Specifies if the customer's billing address country and geo-IP address are not the same.","type":"boolean","readOnly":true},"hasMismatchedBankCountry":{"description":"Specifies if the customer's bank country and geo-IP address are not the same.","type":"boolean","readOnly":true},"hasMismatchedTimeZone":{"description":"Specifies if the customer's browser time zone and the IP address associated time zone are not the same.","type":"boolean","readOnly":true},"hasMismatchedHolderName":{"description":"Specifies if the customer's billing address name and primary address name are not the same.","type":"boolean","readOnly":true},"hasFakeName":{"description":"Specifies if the holder name seems fake.","type":"boolean","readOnly":true},"isHighRiskCountry":{"description":"Specifies if the geo-IP country, or the customer's billing country, is considered a high risk country.","type":"boolean","readOnly":true},"paymentInstrumentVelocity":{"description":"Number of transactions for this payment instrument, based on fingerprint, in the last 24 hours.","type":"integer","readOnly":true},"declinedPaymentInstrumentVelocity":{"description":"Number of declined transactions for this payment instrument fingerprint in the last 24 hours.","type":"integer","readOnly":true},"deviceVelocity":{"description":"Number of transactions for this device, based on fingerprint, in the last 24 hours.","type":"integer","readOnly":true},"ipVelocity":{"description":"Number of transactions for this IP address in the last 24 hours.","type":"integer","readOnly":true},"emailVelocity":{"description":"Number of transactions for this email address in the last 24 hours.","type":"integer","readOnly":true},"billingAddressVelocity":{"description":"Number of transactions for this billing address in the last 24 hours.","type":"integer","readOnly":true},"paymentInstrumentApprovedTransactionCount":{"description":"Number of approved transactions for this payment instrument.","type":"integer","readOnly":true},"score":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Computed risk score based on IP risk data,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"such as: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isVpn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isTor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isProxy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer","readOnly":true}}}},"components/schemas/TransactionLimitAmount":{"id":"components/schemas/TransactionLimitAmount","kind":"json-schema","title":"LimitAmount","data":{"type":["object","null"],"title":"LimitAmount","description":"Transaction amount limit information.","properties":{"amount":{"type":"number","format":"double","example":275.35,"description":"Limit amount."},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"resetTime":{"type":["string","null"],"format":"date-time","description":"Date and time in which the limit amount resets.\nThis value may be used for user interfaces."}}}},"components/schemas/Transaction":{"id":"components/schemas/Transaction","kind":"json-schema","title":"Transaction","data":{"type":"object","description":"Transaction information.","properties":{"id":{"readOnly":true,"$ref":"#/components/schemas/TransactionId"},"websiteId":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/WebsiteId"}]},"customerId":{"x-basic":true,"x-sortable":true,"allOf":[{"$ref":"#/components/schemas/CustomerId"}]},"type":{"description":"Type of transaction.","type":"string","x-basic":true,"readOnly":true,"enum":["3ds-authentication","authorize","capture","credit","refund","sale","setup","void"]},"status":{"description":"Status of the transaction.","type":"string","readOnly":true,"enum":["completed","conn-error","disputed","never-sent","offsite","partially-refunded","pending","refunded","sending","timeout","voided","waiting-approval","waiting-capture","waiting-gateway","waiting-refund"]},"result":{"description":"Result of the transaction.","type":"string","x-basic":true,"readOnly":true,"enum":["abandoned","approved","canceled","declined","unknown"]},"amount":{"x-type":"Money","x-sortable":true,"x-basic":true,"description":"Total amount of the transaction.","type":"number","format":"double","readOnly":true},"currency":{"readOnly":true,"$ref":"#/components/schemas/CurrencyCode"},"purchaseAmount":{"description":"Amount by which the purchase is completed.\nIf an adjustment occurs, the purchased amount may differ from the requested amount.","type":"number","format":"double","x-type":"Money","x-currency-field":"purchaseCurrency","x-sortable":true,"readOnly":true},"purchaseCurrency":{"readOnly":true,"$ref":"#/components/schemas/CurrencyCode"},"requestAmount":{"description":"Amount of the payment request.\nIf an adjustment occurs,\nthe purchase amount may differ from the billing amount.","type":"number","x-type":"Money","x-currency-field":"requestCurrency","format":"double","readOnly":true},"requestCurrency":{"readOnly":true,"$ref":"#/components/schemas/CurrencyCode"},"parentTransactionId":{"description":"ID of the parent transaction.","type":["string","null"],"$ref":"#/components/schemas/TransactionId"},"childTransactions":{"description":"IDs of child transactions.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/ResourceId"}},"invoiceIds":{"description":"Related invoice IDs.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/ResourceId"}},"subscriptionIds":{"description":"Subscription IDs of invoices that are related to the transaction.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/ResourceId"}},"planIds":{"description":"Plan IDs of orders that are related to the transaction.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/ResourceId"}},"isRebill":{"description":"Specifies if the transaction is one of a number of recurring payments in a subscription, excluding trials or setup fees.","type":"boolean","readOnly":true},"rebillNumber":{"description":"Rebill number of the transaction.\nA rebill number is the number of recurring payments in a subscription, excluding trials or setup fees.","type":"integer","readOnly":true,"x-sortable":true},"billingAddress":{"description":"Billing address.","$ref":"#/components/schemas/ContactObject"},"has3ds":{"description":"Specifies if the transaction uses 3D Secure.","type":"boolean","readOnly":true},"3ds":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication object."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/docs/settings/3ds/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3D Secure (3DS)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"readOnly":true,"properties":{"server":{"description":"Name of the 3D Secure server.","type":"string"},"version":{"description":"Version of 3D Secure.","type":"string","enum":["1.0.2","2.1.0","2.2.0"]},"enrolled":{"description":"Specifies if the cardholder is enrolled in 3D Secure.","type":"string","enum":["yes","no","invalid card/timeout","unavailable"]},"authenticated":{"description":"Authentication response status for 3D Secure.","type":"string","enum":["yes","no","not applicable","attempted"]},"liability":{"type":"string","enum":["protected","not protected","protected (attempt)"]},"flow":{"description":"Authentication flow for 3D Secure 2.","type":"string","enum":["frictionless","challenge"]},"isDowngraded":{"description":"Specifies if 3D Secure 2 is attempted and downgraded to 3D Secure 1.","type":"boolean","default":false,"deprecated":true}}},"redirectUrl":{"description":"URL where the end-user is redirected to when an offsite transaction is completed.\nThe default value is the website URL.","type":["string","null"],"maxLength":2083,"format":"uri"},"retryNumber":{"type":"integer","readOnly":true,"description":"Position of the transaction in the sequence of retries.","x-sortable":true},"isRetry":{"type":"boolean","readOnly":true,"description":"Specifies if a transaction is a retry."},"billingDescriptor":{"type":["string","null"],"readOnly":true,"description":"Billing descriptor that appears on the periodic billing statement.\nFor a credit card statement, this field commonly contains 12 or fewer characters."},"description":{"type":"string","description":"Description of the payment.","maxLength":255},"requestId":{"description":"Request ID of the transaction.\nThis ID must be unique within a 24-hour period.\nUse this field to prevent duplicate transactions.","type":"string","x-sortable":true},"hasAmountAdjustment":{"description":"Specifies if the transaction has amount adjustment.","type":"boolean","readOnly":true},"gatewayName":{"readOnly":true,"description":"Name of the payment gateway that processed, or is selected to process, the transaction.\nThis value is only available after a gateway is selected for the transaction.","x-label":"Gateway","x-basic":true,"allOf":[{"$ref":"#/components/schemas/GatewayName"}]},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"processedTime":{"description":"Date and time when the transaction is processed.","x-sortable":true,"x-basic":true,"$ref":"#/components/schemas/ServerTimestamp"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"gatewayAccountId":{"type":["string","null"],"description":"ID of the gateway account that processed the transaction.","maxLength":50,"example":"gw_acc_0YVCXMF26DDNKAERE5NW727S34","readOnly":true},"gatewayTransactionId":{"description":"ID of the gateway transaction.","readOnly":true,"type":["string","null"],"maxLength":50,"example":"txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"},"gateway":{"type":"object","description":"Related gateway information.","readOnly":true,"properties":{"response":{"description":"Gateway response.","type":"object","properties":{"code":{"description":"Gateway response code.","type":["string","null"]},"message":{"description":"Gateway response message.","type":["string","null"]},"type":{"description":"Gateway response type.","type":["string","null"]},"originalCode":{"description":"Raw, unmapped gateway response code.","type":["string","null"]},"originalMessage":{"description":"Raw, unmapped gateway response message.","type":["string","null"]}}},"avsResponse":{"description":"Gateway Address Verification System (AVS) response.","type":"object","properties":{"code":{"description":"Response code.","type":["string","null"]},"message":{"description":"Response message.","type":["string","null"]},"originalCode":{"description":"Raw response code.","type":["string","null"]},"originalMessage":{"description":"Raw response message.","type":["string","null"]}}},"cvvResponse":{"description":"Gateway Card Verification Value (CVV) response.","type":"object","properties":{"code":{"description":"Response code.","type":["string","null"]},"message":{"description":"Response message.","type":["string","null"]},"originalCode":{"description":"Raw response code.","type":["string","null"]},"originalMessage":{"description":"Raw response message.","type":["string","null"]}}}}},"acquirerName":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acquirer name."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is only available when a transaction uses a payment gateway."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a transaction does not use a payment gateway, this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/AcquirerName"}]},"method":{"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrument.method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]}],"allOf":[{"$ref":"#/components/schemas/PaymentMethod"}]},"velocity":{"description":"Number of transactions by the same customer in the past 24 hours.","type":"integer"},"revision":{"description":"Number of times the transaction data has been modified.\n\nThis revision number is useful when analyzing webhook data to determine if the change takes precedence over the current representation.","type":"integer","readOnly":true},"referenceData":{"description":"Transaction reference data.","type":["object","null"],"additionalProperties":{"type":"string"},"example":{"gatewayTransactionId":"GAT123"},"readOnly":true},"bin":{"description":"Payment card Bank Identification Number (BIN).","x-label":"BIN","type":["string","null"],"format":"bin","readOnly":true},"paymentInstrument":{"type":"object","oneOf":[{"$ref":"#/components/schemas/VaultedInstrument"},{"$ref":"#/components/schemas/AlternativePaymentInstrument"},{"$ref":"#/components/schemas/CashInstrument"},{"$ref":"#/components/schemas/CheckInstrument"}]},"hasDcc":{"description":"Specifies if Dynamic Currency Conversion (DCC) applies to the transaction.","type":"boolean","readOnly":true},"dcc":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detailed Dynamic currency conversion (DCC)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If DCC is not applied to the transaction, this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["object","null"],"readOnly":true,"properties":{"base":{"description":"Initial amount and currency to convert from.","$ref":"#/components/schemas/Money"},"quote":{"description":"Suggested amount and currency to convert to.","$ref":"#/components/schemas/Money"},"usdMarkup":{"description":"Markup amount converted to USD.","$ref":"#/components/schemas/MoneyAmount"},"outcome":{"type":"string","description":"Dynamic currency conversion outcome.","enum":["unprocessed","rejected","selected"]},"isForceDcc":{"description":"Specifies if Dynamic Currency Conversion (DCC) is forced for the transaction.","type":"boolean"}}},"riskScore":{"description":"Risk score for the transaction.","type":"integer","readOnly":true,"x-sortable":true},"riskMetadata":{"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"notificationUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where a server-to-server POST notification is sent."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This notification is sent when the transaction result is finalized after a timeout or an offsite interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not interpret this notification as a confirmation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complete a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to confirm the result of the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure the request is not reattempted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when the result is confirmed, respond with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following placeholders are available to use in this URI: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{result}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These placeholders are replaced the with the transaction ID and result accordingly."},"children":[]}]}]}],"type":["string","null"],"maxLength":2083,"format":"uri"},"isDisputed":{"description":"Specifies if a transaction is disputed.","type":"boolean","readOnly":true},"disputeTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the dispute is created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the transaction is not disputed, this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"format":"date-time","readOnly":true,"x-sortable":true},"disputeStatus":{"description":"Status of the dispute.","type":["string","null"],"readOnly":true,"enum":[null,"response-needed","under-review","forfeited","won","lost","unknown"]},"isReconciled":{"description":"Specifies if the transaction is verified with gateway batch data.","type":"boolean","readOnly":true},"isProcessedOutside":{"description":"Specifies if the transaction is processed outside of Rebilly.","type":"boolean"},"isMerchantInitiated":{"description":"Specifies if the transaction is initiated by the merchant.","type":"boolean"},"hadDiscrepancy":{"description":"Specifies if the transaction is updated due to a discrepancy with its source of truth.","type":"boolean","readOnly":true},"orderId":{"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order ID of the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This ID must be unique within a 24 hour period."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field instead."},"children":[]}]}]}]}],"type":"string","x-sortable":true},"arn":{"x-label":"ARN","type":["string","null"],"readOnly":true,"description":"Acquirer reference number.","example":"74836950144358910018150"},"reportAmount":{"description":"Transaction amount converted to the report currency of the organization.","type":"number","x-type":"Money","x-sortable":true,"x-currency-field":"reportCurrency","format":"double","readOnly":true},"reportCurrency":{"readOnly":true,"$ref":"#/components/schemas/CurrencyCode"},"settlementTime":{"type":["string","null"],"description":"Date and time when the transaction is settled by the banking institution.","format":"date-time","readOnly":true,"x-sortable":true},"discrepancyTime":{"type":["string","null"],"description":"Date and time of the most recent discrepancy on the transaction.","format":"date-time","readOnly":true,"x-sortable":true},"limits":{"$ref":"#/components/schemas/TransactionLimitAmount"},"organizationId":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/OrganizationId"}]},"depositRequestId":{"readOnly":true,"type":["string","null"],"description":"ID of the deposit request if applicable.\nThe created transaction is based on the properties of this deposit request.","maxLength":50,"example":"dep_req_0YVJ65BSGYC3EAT58SEX8KY6J7"},"transferId":{"readOnly":true,"type":["string","null"],"description":"ID of the ledger transfer if applicable.\nThe transaction is linked to this transfer when processed in the wallet ledger.","maxLength":50,"example":"tb_0YVDTQJ8YWDGQACV2N2N5SPWQ0"},"payoutRequestId":{"readOnly":true,"type":["string","null"],"description":"ID of the payout request if applicable.\nThe created transaction is based on the properties of this payout request.","maxLength":50,"example":"pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","attachments","website","customer","gatewayAccount","paymentCard","parentTransaction","leadSource","approvalUrl","refundUrl","updateUrl","disputes","invoices","queryUrl","redirectUrl"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"parentTransaction":{"type":"object"},"childTransactions":{"type":"array","maxItems":10,"description":"Most recent child transactions."},"gatewayAccount":{"type":"object"},"customer":{"type":"object"},"leadSource":{"type":"object"},"website":{"type":"object"},"invoices":{"type":"array","maxItems":10,"description":"Most recent related invoices."},"organization":{"type":"object"},"dispute":{"type":"object"},"paymentCard":{"type":"object"},"bankAccount":{"type":"object"}}}}}},"components/schemas/TimeUnit":{"id":"components/schemas/TimeUnit","kind":"json-schema","title":"TimeUnit","data":{"type":"string","enum":["second","minute","hour","day","month","year"]}},"components/schemas/TimePluralUnit":{"id":"components/schemas/TimePluralUnit","kind":"json-schema","title":"TimePluralUnit","data":{"type":"string","enum":["seconds","minutes","hours","days","months","years"]}},"components/schemas/TimeIso8601Extended":{"id":"components/schemas/TimeIso8601Extended","kind":"json-schema","title":"TimeIso8601Extended","data":{"description":"Extended ISO-8601 format of time.","type":"string","format":"time","pattern":"^(([01][0-9]|2[0-3]):([0-5][0-9])(?::([0-5][0-9]))?)((?:[+-](?:0[0-9]|1[12])(?::?[0-5][0-9])?)|Z)?$"}},"components/schemas/SchedulingMethodDayOfMonth":{"id":"components/schemas/SchedulingMethodDayOfMonth","kind":"json-schema","title":"SchedulingMethodDayOfMonth","data":{"type":"object","properties":{"method":{"type":"string","enum":["day-of-month"]},"day":{"type":"integer","minimum":1,"maximum":31,"description":"Day of the month in which the event occurs.\nIf the month has less days, the last day of the month is selected."},"time":{"$ref":"#/components/schemas/TimeIso8601Extended"}},"required":["day","method"]}},"components/schemas/SchedulingMethodDayOfWeek":{"id":"components/schemas/SchedulingMethodDayOfWeek","kind":"json-schema","title":"SchedulingMethodDayOfWeek","data":{"type":"object","properties":{"method":{"type":"string","enum":["day-of-week"]},"day":{"description":"Day of the week when the event occurs.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"week":{"type":"string","enum":["next","first-in-month","last-in-month"]},"time":{"$ref":"#/components/schemas/TimeIso8601Extended"}},"required":["day","week","method"]}},"components/schemas/PeriodAnchor":{"id":"components/schemas/PeriodAnchor","kind":"json-schema","title":"PeriodAnchor","data":{"type":"object","description":"Instruction for calculating the period anchor.","discriminator":{"propertyName":"method","mapping":{"day-of-month":"#/components/schemas/SchedulingMethodDayOfMonth","day-of-week":"#/components/schemas/SchedulingMethodDayOfWeek"}},"oneOf":[{"$ref":"#/components/schemas/SchedulingMethodDayOfMonth"},{"$ref":"#/components/schemas/SchedulingMethodDayOfWeek"}]}},"components/schemas/SchedulingMethodDateInterval":{"id":"components/schemas/SchedulingMethodDateInterval","kind":"json-schema","title":"SchedulingMethodDateInterval","data":{"type":"object","properties":{"method":{"type":"string","enum":["date-interval"]},"duration":{"type":"integer","description":"Number of time units.","minimum":1},"unit":{"description":"Unit of time.","oneOf":[{"$ref":"#/components/schemas/TimeUnit"},{"$ref":"#/components/schemas/TimePluralUnit"}]},"anchor":{"$ref":"#/components/schemas/PeriodAnchor"}},"required":["duration","unit","method"]}},"components/schemas/SchedulingMethodImmediately":{"id":"components/schemas/SchedulingMethodImmediately","kind":"json-schema","title":"SchedulingMethodImmediately","data":{"type":"object","required":["method"],"properties":{"method":{"type":"string","enum":["immediately"]}}}},"components/schemas/SchedulingMethodIntelligent":{"id":"components/schemas/SchedulingMethodIntelligent","kind":"json-schema","title":"SchedulingMethodIntelligent","data":{"type":"object","properties":{"method":{"type":"string","enum":["intelligent"]},"duration":{"type":"integer","description":"Latest point in time at which the event should occur.\nThe event occurs at a random time between the initial time and duration time.","minimum":1},"unit":{"description":"Unit of time.","oneOf":[{"$ref":"#/components/schemas/TimeUnit"},{"$ref":"#/components/schemas/TimePluralUnit"}]}},"required":["duration","unit","method"]}},"components/schemas/InvoiceRetryScheduleInstruction":{"id":"components/schemas/InvoiceRetryScheduleInstruction","kind":"json-schema","title":"InvoiceRetryScheduleInstruction","data":{"type":"object","description":"Specifies when the payment retry instruction is performed.","discriminator":{"propertyName":"method","mapping":{"date-interval":"#/components/schemas/SchedulingMethodDateInterval","day-of-month":"#/components/schemas/SchedulingMethodDayOfMonth","day-of-week":"#/components/schemas/SchedulingMethodDayOfWeek","immediately":"#/components/schemas/SchedulingMethodImmediately","intelligent":"#/components/schemas/SchedulingMethodIntelligent"}},"oneOf":[{"$ref":"#/components/schemas/SchedulingMethodDateInterval"},{"$ref":"#/components/schemas/SchedulingMethodDayOfMonth"},{"$ref":"#/components/schemas/SchedulingMethodDayOfWeek"},{"$ref":"#/components/schemas/SchedulingMethodImmediately"},{"$ref":"#/components/schemas/SchedulingMethodIntelligent"}]}},"components/schemas/AmountAdjustmentPoliciesNone":{"id":"components/schemas/AmountAdjustmentPoliciesNone","kind":"json-schema","title":"None","data":{"title":"None","type":"object","required":["method"],"properties":{"method":{"type":"string","enum":["none"],"description":"No payment amount adjustment."}}}},"components/schemas/AmountAdjustmentPoliciesDiscountAmountRemaining":{"id":"components/schemas/AmountAdjustmentPoliciesDiscountAmountRemaining","kind":"json-schema","title":"Discount remaining amount","data":{"title":"Discount remaining amount","type":"object","required":["method"],"properties":{"method":{"type":"string","enum":["discount-amount-remaining"],"description":"Discount the remaining amount on the invoice."}}}},"components/schemas/AmountAdjustmentInstructionPartial":{"id":"components/schemas/AmountAdjustmentInstructionPartial","kind":"json-schema","title":"AmountAdjustmentInstructionPartial","data":{"type":"object","required":["method","value","type"],"properties":{"method":{"type":"string","enum":["partial"]},"value":{"description":"Amount of the payment.","type":"number","format":"float"},"type":{"description":"Payment amount type.","type":"string","enum":["percent","fixed"]},"afterApprovalPolicy":{"description":"After an approved payment retry for an adjusted amount, this field specifies whether to discount the remaining invoice amount.","discriminator":{"propertyName":"method","mapping":{"none":"#/components/schemas/AmountAdjustmentPoliciesNone","discount-amount-remaining":"#/components/schemas/AmountAdjustmentPoliciesDiscountAmountRemaining"}},"oneOf":[{"$ref":"#/components/schemas/AmountAdjustmentPoliciesNone"},{"$ref":"#/components/schemas/AmountAdjustmentPoliciesDiscountAmountRemaining"}]}}}},"components/schemas/AmountAdjustmentInstructionNone":{"id":"components/schemas/AmountAdjustmentInstructionNone","kind":"json-schema","title":"AmountAdjustmentInstructionNone","data":{"type":"object","required":["method"],"properties":{"method":{"type":"string","enum":["none"]}}}},"components/schemas/InvoiceRetryAmountAdjustmentInstruction":{"id":"components/schemas/InvoiceRetryAmountAdjustmentInstruction","kind":"json-schema","title":"InvoiceRetryAmountAdjustmentInstruction","data":{"type":"object","description":"Specifies if the payment amount must be adjusted for the retry.","discriminator":{"propertyName":"method","mapping":{"partial":"#/components/schemas/AmountAdjustmentInstructionPartial","none":"#/components/schemas/AmountAdjustmentInstructionNone"}},"oneOf":[{"$ref":"#/components/schemas/AmountAdjustmentInstructionPartial"},{"$ref":"#/components/schemas/AmountAdjustmentInstructionNone"}]}},"components/schemas/Invoice":{"id":"components/schemas/Invoice","kind":"json-schema","title":"Invoice","data":{"required":["customerId","currency","websiteId"],"properties":{"id":{"type":"string","description":"ID of the invoice.","readOnly":true,"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"websiteId":{"$ref":"#/components/schemas/WebsiteId"},"invoiceNumber":{"description":"Auto-incrementing number based on the sequence of invoices for any particular customer.","readOnly":true,"type":"integer","x-basic":true},"orderId":{"description":"ID of the order (experimental).","readOnly":true,"example":"ord_01HVKA5975PJBSQ1SX72G3MSZC","type":["string","null"]},"subscriptionId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the related subscription order, if available."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if there are no related subscription orders."},"children":[]}]}]}],"readOnly":true,"maxLength":50,"example":"sub_01HRF27SATGE4Z6PBJE6PD8328"},"quoteId":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the related quote, if available."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if there are no related quotes."},"children":[]}]}]}],"readOnly":true,"maxLength":50,"example":"qt_01HXBZMEGPETPHJZH6V4RHBMA8"},"currency":{"x-sortable":true,"x-basic":true,"$ref":"#/components/schemas/CurrencyCode"},"amount":{"description":"Amount of the invoice.","type":"number","x-type":"Money","x-sortable":true,"x-basic":true,"format":"double","readOnly":true},"amountDue":{"description":"Amount that is due on the invoice.","type":"number","x-type":"Money","x-sortable":true,"format":"double","readOnly":true},"subtotalAmount":{"description":"Subtotal amount of the invoice.","type":"number","x-type":"Money","format":"double","readOnly":true},"discountAmount":{"description":"Discount amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double","readOnly":true},"shipping":{"$ref":"#/components/schemas/Shipping"},"tax":{"$ref":"#/components/schemas/Taxes"},"organizationTaxIdNumber":{"description":"Organization tax ID number that is displayed on the invoice.","type":["object","null"],"required":["type","value"],"properties":{"type":{"type":"string","description":"Type of the tax ID number.","enum":["eu-vat","other"],"example":"eu-vat"},"value":{"type":"string","description":"Value of the tax ID number.","example":"GB980780684"}}},"customerTaxIdNumber":{"description":"Customer tax ID number that is displayed on the invoice.","type":["object","null"],"required":["type","value"],"properties":{"type":{"type":"string","description":"Type of the tax ID number.","enum":["eu-vat","other"],"example":"eu-vat"},"value":{"type":"string","description":"Value of the tax ID number.","example":"GB980780684"}}},"billingAddress":{"description":"Billing address of the invoice.\nAfter the first payment is made for an invoice, this value cannot be changed.","$ref":"#/components/schemas/ContactObject"},"deliveryAddress":{"description":"Delivery address of the invoice.","$ref":"#/components/schemas/ContactObject"},"poNumber":{"description":"Purchase order number that is displayed on the invoice.","type":["string","null"],"example":"PO123456","maxLength":50},"notes":{"description":"Notes for the customer that are displayed on the invoice.","type":"string","maxLength":65535},"items":{"type":"array","description":"Invoice items array.","readOnly":true,"items":{"$ref":"#/components/schemas/InvoiceItem"}},"discounts":{"type":"array","description":"Discounts applied.","readOnly":true,"items":{"type":"object","readOnly":true,"properties":{"couponId":{"type":"string","description":"ID of the coupon.","maxLength":50,"example":"cpn_0YVCNKF81GD778N4YNVGDJK558"},"redemptionId":{"description":"ID of the redemption.","$ref":"#/components/schemas/ResourceId"},"amount":{"description":"Total amount discounted by this coupon.","type":"number","format":"double"},"description":{"type":"string","description":"Description of the discount."},"context":{"$ref":"#/components/schemas/DiscountContext"}}}},"autopayScheduledTime":{"description":"Date and time when an automatic payment (autopay) is scheduled.","type":["string","null"],"x-sortable":true,"format":"date-time"},"autopayRetryNumber":{"description":"Number of times that an automatic payment (autopay) has been attempted on an invoice.","readOnly":true,"type":"integer","x-sortable":true,"minimum":0,"default":0},"status":{"type":"string","description":"Status of the invoice.","x-basic":true,"readOnly":true,"enum":["draft","quotation","unpaid","paid","partially-paid","past-due","abandoned","voided","partially-refunded","refunded","disputed"]},"delinquentCollectionPeriod":{"type":"integer","description":"Length of time, in days, between when the invoice is due and when the invoice is paid.","x-sortable":true,"readOnly":true},"collectionPeriod":{"type":"integer","x-sortable":true,"description":"Length of time, in days, between when the invoice is issued and when the invoice is paid.","readOnly":true},"abandonedTime":{"description":"Date and time when the invoice is abandoned.","x-sortable":true,"type":["string","null"],"format":"date-time","readOnly":true},"voidedTime":{"description":"Date and time when the invoice is voided.","x-sortable":true,"type":["string","null"],"format":"date-time","readOnly":true},"paidTime":{"x-label":"Payment Date","x-sortable":true,"x-basic":true,"description":"Date and time when the invoice is paid.","type":["string","null"],"format":"date-time","readOnly":true},"dueTime":{"description":"Date and time when the invoice is due for payment.","type":"string","x-sortable":true,"format":"date-time"},"issuedTime":{"description":"Date and time when the invoice is issued.","x-label":"Date Issued","x-sortable":true,"x-basic":true,"$ref":"#/components/schemas/ServerTimestamp"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"paymentFormUrl":{"type":["string","null"],"readOnly":true,"format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the customer is redirected to pay the invoice"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"using one of the methods which are available to the customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an alternative to creating a new transaction with empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"creditMemoAllocations":{"type":"array","description":"Credit memo allocations to an invoice.","readOnly":true,"items":{"$ref":"#/components/schemas/CreditMemoInvoiceAllocation"}},"isNewOrder":{"description":"Specifies if the order is a new order.","type":"boolean","readOnly":true,"example":true},"customerId":{"x-basic":true,"allOf":[{"$ref":"#/components/schemas/CustomerId"}]},"transactions":{"type":"array","description":"Invoice transactions array.","maxItems":10,"readOnly":true,"items":{"$ref":"#/components/schemas/Transaction"}},"retryInstruction":{"description":"Invoice payment retry instruction.\nThis object specifies how to proceed if a payment related to the invoice fails.","type":["object","null"],"properties":{"attempts":{"type":"array","description":"Describes the retry instruction.","minItems":1,"items":{"type":"object","properties":{"scheduleInstruction":{"$ref":"#/components/schemas/InvoiceRetryScheduleInstruction"},"amountAdjustmentInstruction":{"$ref":"#/components/schemas/InvoiceRetryAmountAdjustmentInstruction"},"tryBackupInstruments":{"description":"Specifies whether to use backup payment instruments on an invoice payment retry.","type":"boolean","default":false}},"required":["scheduleInstruction"]}},"afterAttemptPolicies":{"description":"Describes the action to take when a payment attempt concludes, and payment is not collected.","type":"array","items":{"type":"string","enum":["change-subscription-renewal-time"]}},"afterRetryEndPolicies":{"description":"Describes the action to take when all scheduled payment retries, in a retry instruction, have concluded and payment is not collected.","type":"array","items":{"type":"string","enum":["abandon-invoice","cancel-subscription"]}}},"required":["attempts","afterAttemptPolicies","afterRetryEndPolicies"]},"revision":{"description":"Number of times the invoice data has been modified.\n\nUse the revision number when analyzing webhook data to\ndetermine if a change should take precedence over the current\nrepresentation.","type":"integer","readOnly":true},"type":{"description":"Type of invoice.","type":"string","enum":["initial","renewal","interim","cancellation","one-time","refund","charge","one-time-sale"],"readOnly":true},"dueReminderTime":{"description":"Date and time when a past due reminder event is triggered.","type":["string","null"],"format":"date-time","readOnly":true},"dueReminderNumber":{"description":"Number of past due reminder events that have been triggered.","type":["integer","null"],"readOnly":true},"organizationId":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/OrganizationId"}]},"delinquencyTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the related order is considered delinquent, and is canceled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no delinquency time is configured."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the order becomes greater than the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delinquencyTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delinquencyTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value becomes equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an invoice is not related to an order, this field can only be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"format":"date-time","default":null},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","website","customer","organization","attachments","leadSource","transactionAllocations","recalculateInvoice","subscription"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"type":"object"},"website":{"type":"object"},"organization":{"type":"object"},"leadSource":{"type":"object"},"shippingRate":{"type":"object"}}}}}},"components/schemas/InvoiceIssue":{"id":"components/schemas/InvoiceIssue","kind":"json-schema","title":"InvoiceIssue","data":{"type":"object","properties":{"issuedTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the invoice is issued."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omitted, the invoice is issued immediately."},"children":[]}]}]}],"type":["string","null"],"format":"date-time"},"dueTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the invoice is due for payment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omitted, this value is set to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuedTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}],"type":["string","null"],"format":"date-time"}}}},"components/schemas/InvoiceReissue":{"id":"components/schemas/InvoiceReissue","kind":"json-schema","title":"InvoiceReissue","data":{"type":"object","properties":{"dueTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the invoice is due for payment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omitted, this value is set to the current date-time."},"children":[]}]}]}],"type":["string","null"],"format":"date-time"}}}},"components/schemas/InvoiceTransactionAllocation":{"id":"components/schemas/InvoiceTransactionAllocation","kind":"json-schema","title":"InvoiceTransactionAllocation","data":{"type":"object","properties":{"invoiceId":{"type":"string","description":"Unique resource ID.","maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"transactionId":{"$ref":"#/components/schemas/TransactionId"},"amount":{"type":"number","format":"double"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["invoice","transaction"]}}}}}}},"components/schemas/InvoiceCreditMemoAllocationRequest":{"id":"components/schemas/InvoiceCreditMemoAllocationRequest","kind":"json-schema","title":"InvoiceCreditMemoAllocationRequest","data":{"type":"object","description":"Allocation request settings.\nCredit memo IDs are not accepted and are selected automatically by the system.","properties":{"amount":{"type":"number","format":"double","exclusiveMinimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional maximum amount to allocate from customer credit memos to the invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If provided, allocation is capped at this value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If omitted, the allocated amount is the lesser of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice unpaid amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available allocatable credit memo balance."},"children":[]}]}]}]}]},"allocationOrder":{"type":"string","description":"Credit memo application order.","enum":["oldest-first","newest-first"],"x-enumDescriptions":{"oldest-first":"Applies oldest allocatable credit memos first.","newest-first":"Applies newest allocatable credit memos first."},"default":"oldest-first"}}}},"components/schemas/InvoiceAppliedCreditMemoAllocation":{"id":"components/schemas/InvoiceAppliedCreditMemoAllocation","kind":"json-schema","title":"InvoiceAppliedCreditMemoAllocation","data":{"type":"object","required":["creditMemoId","amount"],"properties":{"creditMemoId":{"type":"string","description":"ID of the credit memo.","readOnly":true,"maxLength":50,"example":"crmm_0YVCNN22TWC3G8H82QNPNVZCHG"},"amount":{"description":"Amount allocated from the credit memo to the invoice.","type":"number","format":"double"}}}},"components/schemas/InvoiceCreditMemoAllocationResponse":{"id":"components/schemas/InvoiceCreditMemoAllocationResponse","kind":"json-schema","title":"InvoiceCreditMemoAllocationResponse","data":{"type":"object","required":["invoiceId","currency","appliedCreditMemos","remainingInvoiceAmount"],"properties":{"invoiceId":{"type":"string","description":"ID of the invoice.","readOnly":true,"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"currency":{"$ref":"#/components/schemas/CurrencyCode","readOnly":true},"appliedCreditMemos":{"type":"array","readOnly":true,"description":"List of credit memos applied to the invoice and the amount allocated from each.","items":{"$ref":"#/components/schemas/InvoiceAppliedCreditMemoAllocation"}},"remainingInvoiceAmount":{"description":"Remaining amount due on the invoice after credit memo allocation.","type":"number","readOnly":true,"format":"double"}}}},"components/schemas/InvoiceTransaction":{"id":"components/schemas/InvoiceTransaction","kind":"json-schema","title":"InvoiceTransaction","data":{"type":"object","required":["transactionId"],"properties":{"transactionId":{"description":"ID of the transaction to apply to the invoice.","$ref":"#/components/schemas/TransactionId"},"amount":{"description":"Amount to be applied to the invoice. This value must not exceed the transaction amount.\nIf omitted, the lesser of the unused transaction amount or the invoice due amount is used.","type":"number","format":"double"}}}},"components/schemas/InvoiceTimeline":{"id":"components/schemas/InvoiceTimeline","kind":"json-schema","title":"InvoiceTimeline","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the timeline message.","readOnly":true,"maxLength":50,"example":"tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC"},"type":{"description":"Type of timeline message.","type":"string","readOnly":true,"enum":["coupon-applied","email-message-sent","invoice-abandoned","invoice-disputed","invoice-issued","invoice-paid","invoice-partially-paid","invoice-partially-refunded","invoice-past-due","invoice-refunded","invoice-reissued","invoice-renewal-payment-declined","invoice-revenue-recognized","invoice-tax-calculation-failed","invoice-voided","quickbooks-credit-memo-created","quickbooks-credit-memo-voided","quickbooks-invoice-created","quickbooks-invoice-task-failed","quickbooks-invoice-updated","quickbooks-invoice-voided","quickbooks-revenue-recognition-created","timeline-comment-created","transaction-abandoned","transaction-approved","transaction-canceled","transaction-declined","transaction-initiated","transaction-partially-refunded","transaction-refunded","transaction-voided"]},"triggeredBy":{"description":"Specifies who, or what, triggered the timeline event.","type":"string","readOnly":true,"enum":["rebilly","app","direct-api"]},"message":{"description":"Describes the message details.","type":"string"},"extraData":{"$ref":"#/components/schemas/TimelineExtraData"},"occurredTime":{"description":"Date and time when the timeline message occurred.","readOnly":true,"$ref":"#/components/schemas/ServerTimestamp"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/CreditMemoTaxItem":{"id":"components/schemas/CreditMemoTaxItem","kind":"json-schema","title":"CreditMemoTaxItem","data":{"type":"object","required":["amount","description"],"properties":{"amount":{"description":"Amount of the tax.","type":"number","format":"double"},"description":{"type":"string","description":"Description of the tax."},"rate":{"description":"Overall sales tax rate which includes state, county, city and district tax.","type":["number","null"],"format":"double"},"stateAmount":{"description":"Amount of sales tax to collect for the state.","type":["number","null"],"format":"double","example":0.94},"countyAmount":{"description":"Amount of sales tax to collect for the county.","type":["number","null"],"format":"double","example":0.04},"cityAmount":{"description":"Amount of sales tax to collect for the city.","type":["number","null"],"format":"double","example":0},"specialDistrictAmount":{"description":"Amount of sales tax to collect for the special district.","type":["number","null"],"format":"double","example":0.38},"stateRate":{"description":"State sales tax rate for given location.","type":["number","null"],"format":"double"},"countyRate":{"description":"County sales tax rate for given location.","type":["number","null"],"format":"double"},"cityRate":{"description":"City sales tax rate for given location.","type":["number","null"],"format":"double"},"specialDistrictRate":{"description":"Special district sales tax rate for given location.","type":["number","null"],"format":"double"},"jurisdictions":{"description":"Jurisdiction names for the invoice.","type":["object","null"],"properties":{"country":{"description":"Two-letter ISO country code for the provided location.","type":["string","null"],"example":"US"},"state":{"description":"Postal abbreviated state name for the provided location.","type":["string","null"],"example":"CA"},"county":{"description":"County name for the provided location.","type":["string","null"],"example":"LOS ANGELES"},"city":{"description":"City name for the provided location.","type":["string","null"],"example":"LOS ANGELES"}}}}}},"components/schemas/CreditMemo":{"id":"components/schemas/CreditMemo","kind":"json-schema","title":"CreditMemo","data":{"type":"object","description":"Credit memo object.","required":["customerId","currency"],"properties":{"id":{"type":"string","description":"ID of the credit memo.","readOnly":true,"maxLength":50,"example":"crmm_0YVCNN22TWC3G8H82QNPNVZCHG"},"number":{"description":"Auto-incrementing number based on the sequence of credit memos for any particular customer.","readOnly":true,"type":"integer"},"allocations":{"type":"object","description":"Allocations reduce the unused amount of a credit memo.","properties":{"transactions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of transactions (typically refunds, credits, and chargebacks) that are allocated to reduce the unused amount of a credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To delete transaction allocations, send an empty transaction allocation array in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To modify transaction allocations, send a modified transaction allocation array in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not want to modify or delete transaction allocations, do not send a transaction allocation array in the request."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"transactionId":{"description":"ID of the transaction to which the credit memo is allocated.","$ref":"#/components/schemas/TransactionId"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of credit that is allocated from the credit memo to the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is not supplied or exceeds the unused amount of the credit memo or the transaction amount, the lesser of the following two values is used:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unused amount of the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction amount."},"children":[]}]}]}]}],"type":"number","format":"double"},"currency":{"readOnly":true,"$ref":"#/components/schemas/CurrencyCode"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"}}}},"invoices":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of invoices that the credit memo is allocated to."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To delete invoice allocations, send an empty invoice allocation array in the request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unpaid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partially-paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"past-due"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" invoices can be deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To modify invoice allocations, send a modified invoice allocation array in the request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unpaid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partially-paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"past-due"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" invoices can be modified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not want to modify or delete invoice allocations, do not send an invoice allocation array in the request."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/CreditMemoInvoiceAllocation"}}}},"items":{"type":"array","description":"Items of the credit memo.","items":{"type":"object","required":["unitPrice","quantity"],"properties":{"id":{"type":"string","description":"ID of the credit memo item.","readOnly":true,"maxLength":50,"example":"crmm_itm_01HXC7PK2C6F367VYCFXDRYMAQ"},"invoiceItemId":{"description":"ID of the invoice item to which the credit item is referenced.","type":["string","null"],"maxLength":50,"example":"ii_0YVFDEQS2KCFTBN9HXWJFY55GV"},"description":{"description":"Description of the credit memo item.","type":"string"},"unitPrice":{"description":"Price of the credit memo item.","type":"number","format":"double"},"quantity":{"description":"Quantity of the credit memo item.","type":"integer"},"price":{"description":"Total price of the credit memo item.","type":"number","format":"double","readOnly":true},"productId":{"type":["string","null"],"description":"ID of the related product.","maxLength":50,"example":"prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"},"planId":{"description":"ID of the related plan.","type":["string","null"],"maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"},"tax":{"description":"Credit memo item tax.","oneOf":[{"$ref":"#/components/schemas/CreditMemoTaxItem"},{"type":"null"}]}}}},"status":{"type":"string","description":"Status of the credit memo.","readOnly":true,"enum":["draft","quotation","issued","applied","partially-applied","voided"],"x-enumDescriptions":{"draft":"Credit memo is in process of being created.\nThe full amount of the credit memo is unused, and the customer has not seen it yet.","quotation":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit memo is associated with a quote."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the customer approves the quotation, the credit memo changes to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"issued":"Credit memo is available with a full amount to be applied.","applied":"The full amount of the credit memo has been applied.\nNo more credit can be created from it.","partially-applied":"A partial amount of the credit memo has been applied.\nA credit can be created from the remaining amount.","voided":"Credit memo has been voided and cannot be used anymore."}},"reason":{"description":"Reason for the credit memo.","type":"string","enum":["return","product-unsatisfactory","order-change","order-cancellation","chargeback","write-off","waiver","customer-credit","prepayment","other"]},"description":{"type":"string","x-basic":true,"description":"Public description, that is visible to customers, which describes the purpose of the credit memo."},"shippingAmount":{"description":"Shipping amount of an invoice to credit.","type":"number","format":"double","default":0,"x-type":"Money"},"taxAmount":{"description":"Sum of items tax amount of an invoice to credit.","readOnly":true,"type":"number","format":"double","default":0,"x-type":"Money"},"totalAmount":{"description":"Total amount of all credits in the credit memo, including items, shipping, and tax.","readOnly":true,"type":"number","format":"double","default":0,"x-type":"Money"},"unusedAmount":{"description":"Unused credit memo amount that has not been allocated.","readOnly":true,"type":"number","format":"double","default":0,"x-type":"Money"},"revision":{"type":"integer","readOnly":true,"description":"Number of times the credit memo has been modified."},"customerId":{"$ref":"#/components/schemas/CustomerId"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"invoiceId":{"type":["string","null"],"description":"ID of the invoice to which the credit memo is issued.","maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"quoteId":{"type":["string","null"],"description":"ID of the related quote.","readOnly":true,"maxLength":50,"example":"qt_0YVF9605RKC62BP14NE2R7V2XT"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","customer","invoice"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"type":"object"}}}}}},"components/schemas/PatchCreditMemo":{"id":"components/schemas/PatchCreditMemo","kind":"json-schema","title":"PatchCreditMemo","data":{"type":"object","description":"Patch credit memo object.","properties":{"allocations":{"type":"object","description":"Allocations reduce the unused amount of a credit memo.","properties":{"transactions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of transactions (typically refunds, credits, and chargebacks) that are allocated to reduce the unused amount of a credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To delete transaction allocations, send an empty transaction allocation array in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To modify transaction allocations, send a modified transaction allocation array in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not want to modify or delete transaction allocations, do not send a transaction allocation array in the request."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"transactionId":{"description":"ID of the transaction to which the credit memo is allocated.","$ref":"#/components/schemas/TransactionId"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of credit that is allocated from the credit memo to the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is not supplied or exceeds the unused amount of the credit memo or the transaction amount, the lesser of the following two values is used:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unused amount of the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction amount."},"children":[]}]}]}]}],"type":"number","format":"double"},"currency":{"readOnly":true,"$ref":"#/components/schemas/CurrencyCode"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"}}}},"invoices":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of invoices that the credit memo is allocated to."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To delete invoice allocations, send an empty invoice allocation array in the request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unpaid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partially-paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"past-due"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" invoices can be deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To modify invoice allocations, send a modified invoice allocation array in the request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unpaid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partially-paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"past-due"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" invoices can be modified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not want to modify or delete invoice allocations, do not send an invoice allocation array in the request."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"invoiceId":{"type":"string","description":"ID of invoice to which the credit memo is allocated.","maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of credit that is allocated from the credit memo to the invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is not supplied or exceeds the unused amount of the credit memo or the invoice due amount, the lesser of the following two values is used:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unused amount of the credit memo."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice due amount."},"children":[]}]}]}]}],"type":"number","format":"double"},"currency":{"readOnly":true,"$ref":"#/components/schemas/CurrencyCode"},"createdTime":{"description":"Date and time at which a credit memo is allocated.","$ref":"#/components/schemas/ServerTimestamp"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"}}}}}},"items":{"type":"array","description":"Items of the credit memo.","items":{"type":"object","required":["unitPrice","quantity"],"properties":{"id":{"type":"string","description":"ID of the credit memo item.","readOnly":true,"maxLength":50,"example":"crmm_itm_01HXC7PK2C6F367VYCFXDRYMAQ"},"invoiceItemId":{"description":"ID of the invoice item to which the credit item is referenced.","type":["string","null"],"maxLength":50,"example":"ii_0YVFDEQS2KCFTBN9HXWJFY55GV"},"description":{"description":"Description of the credit memo item.","type":"string"},"unitPrice":{"description":"Price of the credit memo item.","type":"number","format":"double"},"quantity":{"description":"Quantity of the credit memo item.","type":"integer"},"price":{"description":"Total price of the credit memo item.","type":"number","format":"double","readOnly":true},"productId":{"type":["string","null"],"description":"ID of the related product.","maxLength":50,"example":"prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"},"planId":{"description":"ID of the related plan.","type":["string","null"],"maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"},"tax":{"description":"Credit memo item tax.","oneOf":[{"$ref":"#/components/schemas/CreditMemoTaxItem"},{"type":"null"}]}}}},"reason":{"description":"Reason for the credit memo.","type":"string","enum":["return","product-unsatisfactory","order-change","order-cancellation","chargeback","write-off","waiver","customer-credit","prepayment","other"]},"description":{"type":"string","x-basic":true,"description":"Public description, that is visible to customers, which describes the purpose of the credit memo."},"shippingAmount":{"description":"Shipping amount of an invoice to credit.","type":"number","format":"double","default":0,"x-type":"Money"}}}},"components/schemas/CreditMemoTimeline":{"id":"components/schemas/CreditMemoTimeline","kind":"json-schema","title":"CreditMemoTimeline","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the timeline message.","readOnly":true,"maxLength":50,"example":"tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC"},"type":{"description":"Type of timeline message.","type":"string","readOnly":true,"enum":["credit-memo-created","credit-memo-applied","credit-memo-partially-applied","credit-memo-voided"]},"triggeredBy":{"description":"Specifies who, or what, triggered the timeline event.","type":"string","readOnly":true,"enum":["rebilly","app","direct-api"]},"message":{"description":"Content of the timeline message.","type":"string"},"extraData":{"$ref":"#/components/schemas/TimelineExtraData"},"occurredTime":{"description":"Date and time when the timeline message occurred.","readOnly":true,"$ref":"#/components/schemas/ServerTimestamp"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/JournalAccount":{"id":"components/schemas/JournalAccount","kind":"json-schema","title":"JournalAccount","data":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"ID of the journal account.","readOnly":true,"maxLength":50,"example":"jrn_acc_0YVCXS791DD8JAK1WV3VHM70ZQ"},"name":{"type":"string","description":"Name of the journal account.","example":"Unearned revenue"},"description":{"type":["string","null"]},"createdTime":{"description":"Date and time when the journal record is created.","$ref":"#/components/schemas/ServerTimestamp"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/JournalEntry":{"id":"components/schemas/JournalEntry","kind":"json-schema","title":"JournalEntry","data":{"type":"object","required":["period","currency"],"properties":{"id":{"type":"string","description":"ID of the journal entry.","readOnly":true,"maxLength":50,"example":"jrn_ent_0YVCXSFCF2DJX99NBBSJCEVETB"},"period":{"type":"object","properties":{"startDate":{"type":"string","format":"date","example":"2022-09-01"},"endDate":{"type":"string","format":"date","example":"2022-09-30"}}},"label":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom label that can be used to filter entries."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual orders are created with the label "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monthly orders are created with the label "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monthly"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"default":"monthly"},"currency":{"description":"Currency of the journal record revenue.","$ref":"#/components/schemas/CurrencyCode"},"description":{"type":"string"},"totalRecognizedAmount":{"description":"Total amount of all revenue recognized at the end of the journal period.","type":"number","format":"double","readOnly":true,"x-sortable":true},"totalEstimatedAmount":{"description":"Total amount of all revenue estimated at the end of the journal period.","type":"number","format":"double","readOnly":true,"x-sortable":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/JournalRecord":{"id":"components/schemas/JournalRecord","kind":"json-schema","title":"JournalRecord","data":{"type":"object","required":["journalEntryId","invoiceItemId","debitAccountId","creditAccountId"],"properties":{"id":{"type":"string","description":"Unique resource ID.","readOnly":true,"maxLength":50,"example":"jrn_rec_0YVCXV2HE5DBT89QV7RXSJEZQ4"},"journalEntryId":{"description":"ID of the journal entry.","type":"string","maxLength":50,"example":"jrn_ent_01JXJ8EF9WVR0W187QZ6WF5703"},"customerId":{"description":"ID of the customer.","type":"string","maxLength":50,"example":"cus_0YV7DDSDD1C8DA64KHH2W33CPF","readOnly":true},"invoiceId":{"type":"string","description":"ID of the invoice.","maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT","readOnly":true},"invoiceItemId":{"type":"string","description":"ID of the invoice item.","maxLength":50,"example":"ii_0YVFDEQS2KCFTBN9HXWJFY55GV"},"type":{"type":"string","readOnly":true,"enum":["automated","manual"]},"estimatedAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of revenue estimated to be recognized at the schedule date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is ignored when updating a journal record with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"automated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["number","null"],"format":"double"},"recognizedAmount":{"description":"Amount of revenue recognized at the journal period end.","type":["number","null"],"format":"double"},"debitAccountId":{"description":"ID of the debit journal account.","type":["string","null"],"maxLength":50,"example":"jrn_acc_01JXJ8S97PTMYX8W01SQ72FSWC"},"creditAccountId":{"description":"ID of the credit journal account.","type":["string","null"],"maxLength":50,"example":"jrn_acc_01JXJ8RW7AWMVAH7DP3VXYQC1W"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"type":"object"},"invoice":{"type":"object"},"invoiceItem":{"type":"object"},"debitAccount":{"type":"object"},"creditAccount":{"type":"object"},"journalEntry":{"type":"object"}}},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","customer","invoice","invoiceItem","journalEntry","creditAccount","debitAccount"]}}}}}}},"components/schemas/KycDocumentTypes":{"id":"components/schemas/KycDocumentTypes","kind":"json-schema","title":"KycDocumentTypes","data":{"type":"string","enum":["identity-proof","address-proof","funds-proof","purchase-proof","credit-file-proof"]}},"components/schemas/KycDocumentSubtypes":{"id":"components/schemas/KycDocumentSubtypes","kind":"json-schema","title":"KycDocumentSubtypes","data":{"type":["string","null"],"enum":["passport","id-card","driver-license","birth-certificate","utility-bill","rental-receipt","lease-agreement","copy-credit-card","credit-card-statement","bank-statement","inheritance-documentation","tax-return","salary-slip","sale-of-assets","public-health-card","proof-of-age-card","reverse-of-id","public-service","ewallet-holder-details","ewallet-transaction-statement","marriage-certificate","firearms-license","insurance-letter","income-statement","debtors-letter","other",null]}},"components/schemas/KycRequestDocument":{"id":"components/schemas/KycRequestDocument","kind":"json-schema","title":"KycRequestDocument","data":{"type":"object","required":["type"],"properties":{"type":{"description":"Type of document to request from the customer.","$ref":"#/components/schemas/KycDocumentTypes"},"subtypes":{"description":"Permitted document subtype.","type":["array","null"],"items":{"$ref":"#/components/schemas/KycDocumentSubtypes"}},"maxAttempts":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of allowed document upload attempts."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to allow unlimited upload attempts."},"children":[]}]}]}],"type":"integer","default":3,"minimum":0,"maximum":100},"faceProofRequired":{"description":"Specifies if the customer must upload a photo of their face (selfie) that matches a provided KYC document.","type":"boolean"},"faceLivenessRequired":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the customer must use the face liveness feature when uploading a selfie."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/kyc-and-aml/kyc#facial-recognition-identity-verification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Facial recognition and identity verification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean"}}}},"components/schemas/KycDocumentMatchLevels":{"id":"components/schemas/KycDocumentMatchLevels","kind":"json-schema","title":"KycDocumentMatchLevels","data":{"description":"Document verification level.","type":"integer","enum":[1,2,3],"default":2,"x-enumDescriptions":{"1":"Moderate verification requirements. This option is used for sale transactions.","2":"Strict verification requirements. This option is used for credit transactions.","3":"Basic verification requirements. This option is used when a high level of verification is not required."}}},"components/schemas/KycRequest":{"id":"components/schemas/KycRequest","kind":"json-schema","title":"KycRequest","data":{"type":"object","description":"KYC request information.","required":["customerId","documents"],"properties":{"id":{"type":"string","readOnly":true,"description":"ID of the KYC request.","maxLength":50,"example":"kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"documents":{"type":"array","description":"Documents to request from the customer.","minItems":1,"items":{"$ref":"#/components/schemas/KycRequestDocument"}},"status":{"description":"Status of the request.","type":"string","readOnly":true,"enum":["gathering","attempted","partial","pending-review","fulfilled","failed","abandoned","expired"],"x-enumDescriptions":{"gathering":"No documents have been provided yet.\nThis is a temporary state.","attempted":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one document has been provided but none were assigned the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a temporary state."},"children":[]}]}]}],"partial":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one requested document has the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but not all requested documents have been assigned the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a temporary state."},"children":[]}]}]}],"pending-review":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one requested document has the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and no requested documents have been assigned the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a temporary state, until the document is reviewed,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or another "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" document is provided."},"children":[]}]}]}],"fulfilled":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All requested documents are provided and have been assigned the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a permanent state."},"children":[]}]}]}],"failed":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one requested document has exhausted all attempts,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and has not been assigned a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in-progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a permanent state."},"children":[]}]}]}],"abandoned":"One or more documents provided but the request expired.\nThis is a permanent state.","expired":"No documents were provided and the request expired.\nThis is a permanent state."}},"redirectUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the customer is redirected when a KYC document upload is complete."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the customer is redirected,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rebilly appends an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"info"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter that has one of the following values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"back"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Customer clicked the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"back to website"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" link."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Customer's token expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Customer uploaded KYC documents that have been analyzed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Customer uploaded KYC documents that require a manual review."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is because the analyzer rejected the documents or could not process them."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Some of the customer's KYC documents have been analyzed,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but other documents have not."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, this may occur when a proof of address document is analyzed but proof of ID is not."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com?info=success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"format":"uri"},"reason":{"description":"Reason for uploading.","example":"spend limit","type":["string","null"]},"matchLevel":{"$ref":"#/components/schemas/KycDocumentMatchLevels"},"revision":{"description":"Number of times the KYC request data has been modified.\n\nUse this value when analyzing webhook data to determine if a change must take precedence over the current representation.","type":"integer","readOnly":true},"expirationTime":{"description":"Date and time when the request expires.\nThe default value is one hour in the future.","type":"string","format":"date-time"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","documents","gatherer"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"documents":{"type":"array"}}}}}},"components/schemas/KycDocumentRejectionReasonTypes":{"id":"components/schemas/KycDocumentRejectionReasonTypes","kind":"json-schema","title":"KycDocumentRejectionReasonTypes","data":{"description":"Reason the document is rejected.","type":"string","enum":["document-unreadable","document-expired","document-was-valid-but-expired","document-not-matching","document-duplicate","document-invalid","document-not-open","underage-person","third-party-or-mismatch","expiration-date-missing","issue-date-missing","subtype-missing","dob-mismatch","name-mismatch","name-and-dob-mismatch","critical-info-missing","old-address-on-id","tampered-document","other"]}},"components/schemas/KycDocumentRejection":{"id":"components/schemas/KycDocumentRejection","kind":"json-schema","title":"KycDocumentRejection","data":{"description":"Reason the document is rejected.","type":["object","null"],"required":["type"],"readOnly":true,"properties":{"type":{"$ref":"#/components/schemas/KycDocumentRejectionReasonTypes"},"message":{"description":"KYC document rejection message.","type":"string","maxLength":255,"example":"Provided document is unreadable"}}}},"components/schemas/KycDocumentMatchesVersion":{"id":"components/schemas/KycDocumentMatchesVersion","kind":"json-schema","title":"KycDocumentMatchesVersion","data":{"type":"string","description":"Version of the document matches.","readOnly":true,"example":"2.0"}},"components/schemas/KycDocumentMatchesScore":{"id":"components/schemas/KycDocumentMatchesScore","kind":"json-schema","title":"KycDocumentMatchesScore","data":{"type":"integer","description":"Calculated score that represents the percentage of confidence that this ID document represents the customer.","minimum":0,"maximum":100,"example":75}},"components/schemas/KycDocumentCheck":{"id":"components/schemas/KycDocumentCheck","kind":"json-schema","title":"KycDocumentCheck","data":{"type":"object","description":"Result of an executed document check during KYC verification.","properties":{"name":{"description":"Name of the document check.","type":"string","enum":["city","containsImage","date","dateIsInvalid","dateOfBirth","decision","documentSubtype","expirationDate","firstName","hasMatchingFaceProof","hasMinimalAge","isIdentityDocument","isPublishedOnline","isTampered","issueDate","lastName","line1","matchesDateOfBirth","phone","postalCode","region"]},"failed":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if a document check has failed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a check fails,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the score value associated with the check is subtracted from the overall score of the proof document."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The overall score together with accept and reject thresholds determine whether an proof document passes or fails verification."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/kyc-and-aml/kyc"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","example":true},"score":{"type":"integer","description":"Specifies the number of points to deduct from the proof document when a check fails during the verification process.","minimum":0,"maximum":100,"example":75},"reason":{"description":"Specifies the reason why the KYC check failed.","type":["string","null"],"example":"closed_eyes"}}}},"components/schemas/KycDocumentCheckList":{"id":"components/schemas/KycDocumentCheckList","kind":"json-schema","title":"KycDocumentCheckList","data":{"type":["array","null"],"description":"List of checks executed against the document during KYC verification.","items":{"$ref":"#/components/schemas/KycDocumentCheck"}}},"components/schemas/KycIdentityMatches":{"id":"components/schemas/KycIdentityMatches","kind":"json-schema","title":"KycIdentityMatches","data":{"type":"object","description":"Matched identity data.","properties":{"containsImage":{"description":"Specifies if the document includes an image that contains a face.","type":"boolean","example":true},"isIdentityDocument":{"description":"Specifies if the document resembles an ID.","type":"boolean","example":true},"isPublishedOnline":{"description":"Specifies if an exact match of the document has been found online.","type":"boolean","example":false},"matchingImages":{"description":"URLs where matching images have been found online.","type":"array","readOnly":true,"maxItems":3,"items":{"type":"string"}},"firstName":{"description":"First name of the customer.\nThis value is null if no match is found.","type":["string","null"],"example":"John"},"lastName":{"description":"Last name of the customer.\nThis value is null if no match is found.","type":["string","null"],"example":"Doe"},"dateOfBirth":{"description":"Date of birth detected on the document.\nThis value is null if no match is detected.","type":["string","null"],"format":"date-time"},"expirationDate":{"description":"Expiration date detected on the document.\nThis value is null if no expiration date is detected.","type":["string","null"],"format":"date-time"},"issueDate":{"description":"Issue date detected on the document.\nThis value is null if no issue date is detected.","type":["string","null"],"format":"date-time"},"hasMinimalAge":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies that the individual is older than the minimal age limit."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimal age is 21+ the for USA and 18+ for all other countries."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is null if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfBirth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not determined."},"children":[]}]}]}],"type":["boolean","null"],"readOnly":true,"example":true},"nationality":{"description":"Nationality detected on a passport or citizenship document.\nThis value is null if no nationality is detected.","type":["string","null"],"example":"US","maxLength":3},"issuanceCountry":{"description":"Country that issued the document.","type":["string","null"],"example":"CA","minLength":2,"maxLength":2},"issuanceRegion":{"description":"Region, state, province, or territory that issued the document.","type":["string","null"],"example":"Ontario"},"documentNumber":{"description":"Unique number on the identity document.\nThis value may contain alphanumeric characters.","type":["string","null"],"example":"1234567890"},"sex":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MRZ sex code (ICAO 9303)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"F"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Null if not extracted."},"children":[]}]}]}],"type":["string","null"],"pattern":"^[MFX]$","example":"M"},"mrzChecksumValid":{"description":"MRZ check digits validation.\nNull if there is no MRZ, no check data, or a non-standard layout.","type":["boolean","null"],"readOnly":true,"example":true},"documentSubtype":{"description":"Interpreted subtype of the uploaded document.","type":["string","null"],"$ref":"#/components/schemas/KycDocumentSubtypes"},"hasMatchingFaceProof":{"description":"Specifies if an identity document has matching face proof.","type":"boolean","example":false},"isTampered":{"description":"Specifies if an identity document has been tampered with.","type":"boolean","example":false},"isDigitallyTampered":{"description":"Specifies if an identity document has been digitally tampered with (experimental).","type":"boolean","example":false},"isPhotocopy":{"description":"Specifies if an identity document is detected as a photocopy.","type":"boolean","example":false},"hasCompletedFaceLiveness":{"description":"Specifies if the face liveness session completed.","type":"boolean","readOnly":true,"example":false},"expiryDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expirationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field instead."},"children":[]}]}]}],"type":["string","null"],"format":"date-time","deprecated":true}}}},"components/schemas/KycSettingsIdentity":{"id":"components/schemas/KycSettingsIdentity","kind":"json-schema","title":"KycSettingsIdentity","data":{"type":"object","description":"Identity proof settings.","properties":{"weights":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Property weights that are used for the KYC document verification process."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All KYC documents start the verification process with a score of 100."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a check fails, the score is reduced by the corresponding weight."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" check weight is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the check fails,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the KYC document score becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"95"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"containsImage":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if the document does not include an image that contains a face."},"isIdentityDocument":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if the document does not resemble an ID."},"isPublishedOnline":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if an exact match of the document is not found online."},"firstName":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if the customer's first name is not matched."},"lastName":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if the customer's last name is not matched."},"expirationDate":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if an expiration date is not detected on the document."},"dateOfBirth":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if a date of birth is not detected on the document, or if the date of birth detected on the document is not matched."},"issueDate":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if an issue date is not detected on the document."},"hasMinimalAge":{"type":"integer","minimum":0,"maximum":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Weight added if the document does not verify the minimal age limit."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimal age is 21+ the for USA and 18+ for all other countries."},"children":[]}]}]}]},"hasMatchingFaceProof":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if an identity document does not have matching face proof."},"nationality":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if a nationality is not detected on the document."},"documentSubtype":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if the document is not one of the recognized document subtypes."},"isTampered":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if the document has been tampered with."},"isPhotocopy":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if the document is detected as a photocopy."},"mrzChecksum":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added when MRZ check digits fail validation."}}},"thresholds":{"type":"object","description":"Pass and fail threshold definition for the document verification process.","properties":{"rejectBelow":{"type":"integer","minimum":0,"maximum":100,"description":"Overall score by which an identity proof document fails the verification process."},"acceptAbove":{"type":"integer","minimum":0,"maximum":100,"description":"Overall score by which an identity proof document passes the verification process."}}},"minimumAgeSettings":{"type":"object","description":"Minimum age settings for identity proof documents.","properties":{"defaultMinimumAge":{"type":"integer","minimum":1,"maximum":100,"description":"Default minimum age requirement for identity proof documents.\nThis is used when no location-specific override is configured.","default":18},"locationOverrides":{"type":"array","description":"Location-specific minimum age.\nEach item specifies a minimum age for a specific location.\nFor country-wide rules, omit the state field.\nFor state-specific rules, include the state field.","items":{"type":"object","required":["country","minimumAge"],"properties":{"country":{"type":"string","description":"Country code in ISO 3166 alpha-2 format.","pattern":"^[A-Z]{2}$","example":"US"},"state":{"type":"string","description":"Name or code of the state or region.","maxLength":45,"example":"AZ"},"minimumAge":{"type":"integer","description":"Minimum age requirement for this location.","minimum":1,"maximum":100,"example":21}}},"example":[{"country":"US","minimumAge":21},{"country":"US","state":"AL","minimumAge":19}]}}}}}},"components/schemas/ProofOfIdentityKycDocument":{"id":"components/schemas/ProofOfIdentityKycDocument","kind":"json-schema","title":"KYC documents.","data":{"title":"KYC documents.","type":"object","required":["customerId","documentType","status","fileIds"],"properties":{"id":{"type":"string","readOnly":true,"description":"ID of the KYC document.","maxLength":50,"example":"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"},"fileIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDs of linked file objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploaded "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" files must have the following tags attached to be used for KYC purposes:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"['kyc', 'id-front']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"['kyc', 'id-back']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"['kyc', 'face-proof']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permitted file types for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" files: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"string","maxLength":50,"example":"file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"}},"documentType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document type submitted for validation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" types are analyzed automatically."},"children":[]}]}]}],"$ref":"#/components/schemas/KycDocumentTypes"},"documentSubtype":{"description":"Document subtype submitted for validation.","$ref":"#/components/schemas/KycDocumentSubtypes"},"status":{"description":"Status of the validation.","type":"string","readOnly":true,"enum":["pending","in-progress","accepted","rejected","archived"],"x-enumDescriptions":{"pending":"Waiting to be reviewed or analyzed.","in-progress":"Being analyzed by the Rebilly AI.","accepted":"Accepted by AI or a human.","rejected":"Rejected by AI or a human.","archived":"Archived by the Rebilly AI."}},"rejectionReason":{"$ref":"#/components/schemas/KycDocumentRejection"},"requestId":{"readOnly":true,"type":["string","null"],"description":"ID of the KYC request.","maxLength":50,"example":"4f6cf35x-2c4y-483z-a0a9-158621f77a21"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"processedTime":{"description":"Date and time when the KYC document is processed.","type":["string","null"],"format":"date-time","readOnly":true},"customerId":{"$ref":"#/components/schemas/CustomerId"},"reviewerId":{"description":"ID of the KYC document reviewer.","type":["string","null"],"readOnly":true,"maxLength":50,"example":"44433322-2c4y-483z-a0a9-158621f77a21"},"reviewerName":{"description":"First and last name of the KYC document reviewer.","type":["string","null"],"readOnly":true},"reviewStartTime":{"description":"Date and time when the manual review starts.","type":["string","null"],"format":"date-time","readOnly":true},"reviewTime":{"description":"Date and time of manual review.","type":["string","null"],"format":"date-time","readOnly":true},"notes":{"description":"Reviewer notes.","type":["string","null"]},"tags":{"description":"List of KYC document tags.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"reason":{"description":"Reason for uploading.","type":["string","null"]},"matchLevel":{"$ref":"#/components/schemas/KycDocumentMatchLevels"},"revision":{"description":"Number of times the KYC document data has been modified.\n\nUse this value when analyzing webhook data to determine if a change must take precedence over the current representation.","type":"integer","readOnly":true},"documentMatches":{"type":["object","null"],"readOnly":true,"description":"Proof of identity document matches.","properties":{"version":{"$ref":"#/components/schemas/KycDocumentMatchesVersion"},"score":{"$ref":"#/components/schemas/KycDocumentMatchesScore"},"checkList":{"$ref":"#/components/schemas/KycDocumentCheckList"},"data":{"$ref":"#/components/schemas/KycIdentityMatches"}}},"parsedData":{"type":["object","null"],"readOnly":true,"description":"Parsed data.","properties":{"version":{"$ref":"#/components/schemas/KycDocumentMatchesVersion"},"score":{"$ref":"#/components/schemas/KycDocumentMatchesScore"},"checkList":{"$ref":"#/components/schemas/KycDocumentCheckList"},"data":{"$ref":"#/components/schemas/KycIdentityMatches"}}},"settings":{"description":"Settings used to score the document.","readOnly":true,"oneOf":[{"$ref":"#/components/schemas/KycSettingsIdentity"},{"type":"null"}]},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","customer"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"type":"object"},"files":{"type":"array","maxItems":3,"description":"Linked files."}}}}}},"components/schemas/KycAddressMatches":{"id":"components/schemas/KycAddressMatches","kind":"json-schema","title":"KycAddressMatches","data":{"type":"object","description":"Matched address data.","properties":{"firstName":{"description":"First name of the customer.\nThis value is null if no match is found.","type":["string","null"],"example":"John"},"lastName":{"description":"Last name of the customer.\nThis value is null if no match is found.","type":["string","null"],"example":"Doe"},"line1":{"description":"Address of the customer's residence.\nThis value is null if no match is found.","type":["string","null"],"example":"36 Craven St"},"city":{"description":"Customer's city of residence.\nThis value is null if no match is found.","type":["string","null"],"example":"London"},"region":{"description":"Customer's region of residence.\nThis value is null if no match is found.","type":["string","null"],"example":"London"},"postalCode":{"description":"Postal code of the customer's residence.\nThis value is null if no match is found.","type":["string","null"],"example":"WC2N 5NF"},"wordCount":{"description":"Total number of words in the document.","type":"integer","example":350},"uniqueWords":{"description":"Total number of unique words in the document.","type":"integer","example":175},"date":{"description":"Date detected on the document.\nUse this field to determine if the document is recent.","type":["string","null"],"format":"date-time","example":"2021-01-01T00:00:00+00:00"},"phone":{"description":"Phone number of the company or agency that issued the document.","type":["string","null"],"example":"(123) 456-7890"},"documentSubtype":{"description":"Interpreted subtype of the uploaded document.","type":["string","null"],"$ref":"#/components/schemas/KycDocumentSubtypes"},"isTampered":{"description":"Specifies if an address proof document has been tampered with.","type":"boolean","example":false}}}},"components/schemas/KycSettingsAddress":{"id":"components/schemas/KycSettingsAddress","kind":"json-schema","title":"KycSettingsAddress","data":{"type":"object","description":"Address proof settings.","properties":{"weights":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Property weights that are used for the KYC document verification process."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All KYC documents start the verification process with a score of 100."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a check fails, the score is reduced by the corresponding weight."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" check weight is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the check fails,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the KYC document score becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"95"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"firstName":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if the customer's first name is not matched."},"lastName":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if the customer's last name is not matched."},"line1":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if the customer's address is not matched."},"city":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if the customer's city is not matched."},"region":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if the customer's region is not matched."},"postalCode":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if the customer's postal code is not matched."},"date":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if a date is not detected on the document."},"phone":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if a phone number is not detected on the document."},"documentSubtype":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if the document is not one of the recognized document subtypes."},"isTampered":{"type":"integer","minimum":0,"maximum":100,"description":"Weight added if the document has been tampered with."}}},"thresholds":{"type":"object","description":"Pass and fail threshold definition for the document verification process.","properties":{"rejectBelow":{"type":"integer","minimum":0,"maximum":100,"description":"Overall score by which an identity proof document fails the verification process."},"acceptAbove":{"type":"integer","minimum":0,"maximum":100,"description":"Overall score by which an identity proof document passes the verification process."}}}}}},"components/schemas/ProofOfAddressKycDocument":{"id":"components/schemas/ProofOfAddressKycDocument","kind":"json-schema","title":"KYC documents.","data":{"title":"KYC documents.","type":"object","required":["customerId","documentType","status","fileIds"],"properties":{"id":{"type":"string","readOnly":true,"description":"ID of the KYC document.","maxLength":50,"example":"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"},"fileIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDs of linked file objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploaded "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" files must have the following tags attached to be used for KYC purposes:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"['kyc', 'id-front']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"['kyc', 'id-back']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"['kyc', 'face-proof']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permitted file types for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" files: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"string","maxLength":50,"example":"file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"}},"documentType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document type submitted for validation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" types are analyzed automatically."},"children":[]}]}]}],"$ref":"#/components/schemas/KycDocumentTypes"},"documentSubtype":{"description":"Document subtype submitted for validation.","$ref":"#/components/schemas/KycDocumentSubtypes"},"status":{"description":"Status of the validation.","type":"string","readOnly":true,"enum":["pending","in-progress","accepted","rejected","archived"],"x-enumDescriptions":{"pending":"Waiting to be reviewed or analyzed.","in-progress":"Being analyzed by the Rebilly AI.","accepted":"Accepted by AI or a human.","rejected":"Rejected by AI or a human.","archived":"Archived by the Rebilly AI."}},"rejectionReason":{"$ref":"#/components/schemas/KycDocumentRejection"},"requestId":{"readOnly":true,"type":["string","null"],"description":"ID of the KYC request.","maxLength":50,"example":"4f6cf35x-2c4y-483z-a0a9-158621f77a21"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"processedTime":{"description":"Date and time when the KYC document is processed.","type":["string","null"],"format":"date-time","readOnly":true},"customerId":{"$ref":"#/components/schemas/CustomerId"},"reviewerId":{"description":"ID of the KYC document reviewer.","type":["string","null"],"readOnly":true,"maxLength":50,"example":"44433322-2c4y-483z-a0a9-158621f77a21"},"reviewerName":{"description":"First and last name of the KYC document reviewer.","type":["string","null"],"readOnly":true},"reviewStartTime":{"description":"Date and time when the manual review starts.","type":["string","null"],"format":"date-time","readOnly":true},"reviewTime":{"description":"Date and time of manual review.","type":["string","null"],"format":"date-time","readOnly":true},"notes":{"description":"Reviewer notes.","type":["string","null"]},"tags":{"description":"List of KYC document tags.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"reason":{"description":"Reason for uploading.","type":["string","null"]},"matchLevel":{"$ref":"#/components/schemas/KycDocumentMatchLevels"},"revision":{"description":"Number of times the KYC document data has been modified.\n\nUse this value when analyzing webhook data to determine if a change must take precedence over the current representation.","type":"integer","readOnly":true},"documentMatches":{"type":["object","null"],"readOnly":true,"properties":{"version":{"$ref":"#/components/schemas/KycDocumentMatchesVersion"},"score":{"$ref":"#/components/schemas/KycDocumentMatchesScore"},"checkList":{"$ref":"#/components/schemas/KycDocumentCheckList"},"data":{"$ref":"#/components/schemas/KycAddressMatches"}}},"parsedData":{"type":["object","null"],"readOnly":true,"properties":{"version":{"$ref":"#/components/schemas/KycDocumentMatchesVersion"},"score":{"$ref":"#/components/schemas/KycDocumentMatchesScore"},"checkList":{"$ref":"#/components/schemas/KycDocumentCheckList"},"data":{"$ref":"#/components/schemas/KycAddressMatches"}}},"settings":{"description":"Settings used to score the document.","readOnly":true,"oneOf":[{"$ref":"#/components/schemas/KycSettingsAddress"},{"type":"null"}]},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","customer"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"type":"object"},"files":{"type":"array","maxItems":3,"description":"Linked files."}}}}}},"components/schemas/FundsMatches":{"id":"components/schemas/FundsMatches","kind":"json-schema","title":"FundsMatches","data":{"type":"object","properties":{"firstName":{"description":"First name of the customer.\nThis value is null if no match is found.","type":["string","null"],"example":"John"},"lastName":{"description":"Last name of the customer.\nThis value is null if no match is found.","type":["string","null"],"example":"Doe"},"documentSubtype":{"description":"Interpreted subtype of the uploaded document.","type":["string","null"],"$ref":"#/components/schemas/KycDocumentSubtypes"}}}},"components/schemas/ProofOfFundsKycDocument":{"id":"components/schemas/ProofOfFundsKycDocument","kind":"json-schema","title":"KYC documents.","data":{"title":"KYC documents.","type":"object","required":["customerId","documentType","status","fileIds"],"properties":{"id":{"type":"string","readOnly":true,"description":"ID of the KYC document.","maxLength":50,"example":"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"},"fileIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDs of linked file objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploaded "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" files must have the following tags attached to be used for KYC purposes:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"['kyc', 'id-front']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"['kyc', 'id-back']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"['kyc', 'face-proof']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permitted file types for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" files: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"string","maxLength":50,"example":"file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"}},"documentType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document type submitted for validation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" types are analyzed automatically."},"children":[]}]}]}],"$ref":"#/components/schemas/KycDocumentTypes"},"documentSubtype":{"description":"Document subtype submitted for validation.","$ref":"#/components/schemas/KycDocumentSubtypes"},"status":{"description":"Status of the validation.","type":"string","readOnly":true,"enum":["pending","in-progress","accepted","rejected","archived"],"x-enumDescriptions":{"pending":"Waiting to be reviewed or analyzed.","in-progress":"Being analyzed by the Rebilly AI.","accepted":"Accepted by AI or a human.","rejected":"Rejected by AI or a human.","archived":"Archived by the Rebilly AI."}},"rejectionReason":{"$ref":"#/components/schemas/KycDocumentRejection"},"requestId":{"readOnly":true,"type":["string","null"],"description":"ID of the KYC request.","maxLength":50,"example":"4f6cf35x-2c4y-483z-a0a9-158621f77a21"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"processedTime":{"description":"Date and time when the KYC document is processed.","type":["string","null"],"format":"date-time","readOnly":true},"customerId":{"$ref":"#/components/schemas/CustomerId"},"reviewerId":{"description":"ID of the KYC document reviewer.","type":["string","null"],"readOnly":true,"maxLength":50,"example":"44433322-2c4y-483z-a0a9-158621f77a21"},"reviewerName":{"description":"First and last name of the KYC document reviewer.","type":["string","null"],"readOnly":true},"reviewStartTime":{"description":"Date and time when the manual review starts.","type":["string","null"],"format":"date-time","readOnly":true},"reviewTime":{"description":"Date and time of manual review.","type":["string","null"],"format":"date-time","readOnly":true},"notes":{"description":"Reviewer notes.","type":["string","null"]},"tags":{"description":"List of KYC document tags.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"reason":{"description":"Reason for uploading.","type":["string","null"]},"matchLevel":{"$ref":"#/components/schemas/KycDocumentMatchLevels"},"settings":{"description":"Settings used to score the document.","type":["object","null"]},"revision":{"description":"Number of times the KYC document data has been modified.\n\nUse this value when analyzing webhook data to determine if a change must take precedence over the current representation.","type":"integer","readOnly":true},"documentMatches":{"type":["object","null"],"readOnly":true,"description":"Proof of funds document matches.","properties":{"version":{"$ref":"#/components/schemas/KycDocumentMatchesVersion"},"score":{"$ref":"#/components/schemas/KycDocumentMatchesScore"},"checkList":{"$ref":"#/components/schemas/KycDocumentCheckList"},"data":{"$ref":"#/components/schemas/FundsMatches"}}},"parsedData":{"type":["object","null"],"readOnly":true,"description":"Parsed data.","properties":{"version":{"$ref":"#/components/schemas/KycDocumentMatchesVersion"},"score":{"$ref":"#/components/schemas/KycDocumentMatchesScore"},"checkList":{"$ref":"#/components/schemas/KycDocumentCheckList"},"data":{"$ref":"#/components/schemas/FundsMatches"}}},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","customer"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"type":"object"},"files":{"type":"array","maxItems":3,"description":"Linked files."}}}}}},"components/schemas/PurchaseMatches":{"id":"components/schemas/PurchaseMatches","kind":"json-schema","title":"PurchaseMatches","data":{"type":"object","properties":{"firstName":{"description":"First name of the customer if it is matched.\nThis value is null if no match is found.","type":["string","null"],"example":"John"},"lastName":{"description":"Last name of the customer if it is matched.\nThis value is null if no match is found.","type":["string","null"],"example":"Doe"},"paymentInstrumentId":{"type":["string","null"],"description":"ID of the payment instrument related to the document.\nThis value is null if no match is found.","example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"},"documentSubtype":{"description":"Interpreted subtype of the uploaded document.","type":["string","null"],"$ref":"#/components/schemas/KycDocumentSubtypes"}}}},"components/schemas/ProofOfPurchaseKycDocument":{"id":"components/schemas/ProofOfPurchaseKycDocument","kind":"json-schema","title":"KYC documents.","data":{"title":"KYC documents.","type":"object","required":["customerId","documentType","status","fileIds"],"properties":{"id":{"type":"string","readOnly":true,"description":"ID of the KYC document.","maxLength":50,"example":"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"},"fileIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDs of linked file objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploaded "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" files must have the following tags attached to be used for KYC purposes:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"['kyc', 'id-front']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"['kyc', 'id-back']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"['kyc', 'face-proof']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permitted file types for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" files: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"string","maxLength":50,"example":"file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"}},"documentType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document type submitted for validation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" types are analyzed automatically."},"children":[]}]}]}],"$ref":"#/components/schemas/KycDocumentTypes"},"documentSubtype":{"description":"Document subtype submitted for validation.","$ref":"#/components/schemas/KycDocumentSubtypes"},"status":{"description":"Status of the validation.","type":"string","readOnly":true,"enum":["pending","in-progress","accepted","rejected","archived"],"x-enumDescriptions":{"pending":"Waiting to be reviewed or analyzed.","in-progress":"Being analyzed by the Rebilly AI.","accepted":"Accepted by AI or a human.","rejected":"Rejected by AI or a human.","archived":"Archived by the Rebilly AI."}},"rejectionReason":{"$ref":"#/components/schemas/KycDocumentRejection"},"requestId":{"readOnly":true,"type":["string","null"],"description":"ID of the KYC request.","maxLength":50,"example":"4f6cf35x-2c4y-483z-a0a9-158621f77a21"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"processedTime":{"description":"Date and time when the KYC document is processed.","type":["string","null"],"format":"date-time","readOnly":true},"customerId":{"$ref":"#/components/schemas/CustomerId"},"reviewerId":{"description":"ID of the KYC document reviewer.","type":["string","null"],"readOnly":true,"maxLength":50,"example":"44433322-2c4y-483z-a0a9-158621f77a21"},"reviewerName":{"description":"First and last name of the KYC document reviewer.","type":["string","null"],"readOnly":true},"reviewStartTime":{"description":"Date and time when the manual review starts.","type":["string","null"],"format":"date-time","readOnly":true},"reviewTime":{"description":"Date and time of manual review.","type":["string","null"],"format":"date-time","readOnly":true},"notes":{"description":"Reviewer notes.","type":["string","null"]},"tags":{"description":"List of KYC document tags.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"reason":{"description":"Reason for uploading.","type":["string","null"]},"matchLevel":{"$ref":"#/components/schemas/KycDocumentMatchLevels"},"settings":{"description":"Settings used to score the document.","type":["object","null"]},"revision":{"description":"Number of times the KYC document data has been modified.\n\nUse this value when analyzing webhook data to determine if a change must take precedence over the current representation.","type":"integer","readOnly":true},"documentMatches":{"type":["object","null"],"readOnly":true,"description":"Proof of purchase document matches.","properties":{"version":{"$ref":"#/components/schemas/KycDocumentMatchesVersion"},"score":{"$ref":"#/components/schemas/KycDocumentMatchesScore"},"checkList":{"$ref":"#/components/schemas/KycDocumentCheckList"},"data":{"$ref":"#/components/schemas/PurchaseMatches"}}},"parsedData":{"type":["object","null"],"readOnly":true,"description":"Parsed data.","properties":{"version":{"$ref":"#/components/schemas/KycDocumentMatchesVersion"},"score":{"$ref":"#/components/schemas/KycDocumentMatchesScore"},"checkList":{"$ref":"#/components/schemas/KycDocumentCheckList"},"data":{"$ref":"#/components/schemas/PurchaseMatches"}}},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","customer","paymentInstrument"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"type":"object"},"files":{"type":"array","maxItems":3,"description":"Linked files."}}}}}},"components/schemas/CreditFileCommonDecisionData":{"id":"components/schemas/CreditFileCommonDecisionData","kind":"json-schema","title":"CreditFileCommonDecisionData","data":{"readOnly":true,"type":"object","properties":{"lastNameMatch":{"description":"Last name match.","type":"string","readOnly":true,"example":"Y"},"firstNameMatch":{"description":"First name match.","type":"string","readOnly":true,"example":"Y"},"civicNumberMatch":{"description":"Civic number match.","type":"string","readOnly":true,"example":"Y"},"streetNameMatch":{"description":"Street name match.","type":"string","readOnly":true,"example":"Y"},"cityMatch":{"description":"City match.","type":"string","readOnly":true,"example":"Y"},"postalCodeMatch":{"description":"Postal code match.","type":"string","readOnly":true,"example":"Y"},"provinceMatch":{"description":"Province match.","type":"string","readOnly":true,"example":"Y"},"dateOfBirthMatch":{"description":"Date of birth match.","type":"string","readOnly":true,"example":"Y"},"ageOfCreditFileThreeOrMoreYearsOld":{"description":"Age of credit file is three or more years old.","type":"string","readOnly":true,"example":"Y"},"addressAsReported":{"description":"Address as reported.","type":"string","readOnly":true,"example":"Y"},"nameAsReported":{"description":"Name as reported.","type":"string","readOnly":true,"example":"Y"},"dateOfBirthAsReported":{"description":"Date of birth as reported.","type":"string","readOnly":true,"example":"Y"}}}},"components/schemas/CreditFileMatches":{"id":"components/schemas/CreditFileMatches","kind":"json-schema","title":"CreditFileMatches","data":{"type":"object","properties":{"creditBureau":{"description":"Credit bureau from which the credit file data is sourced.","type":"string","readOnly":true,"enum":["equifax","experian","transunion","test-bureau"]},"creditFileNumber":{"description":"Credit file number from the credit bureau.","type":"string","readOnly":true},"name":{"description":"Name of the person to consult about the credit file.","type":"string","readOnly":true},"consultedDate":{"description":"Date to consult with the credit bureau about the credit file.","type":"string","format":"date-time","readOnly":true},"decision":{"description":"Specifies if the credit file is used in a single source, or as part of a dual source, proof of identity decision.","type":"string","enum":["single-source","dual-source","other"],"x-enumDescriptions":{"single-source":"Credit file used as a single source of proof for an identity decisions.","dual-source":"Credit file used as a source of proof where the credit bureau agency found two reliable trade sources.\nAt least two sources are required for a dual-source proof of identity decision.","other":"Credit file cannot be used for KYC decisions."},"readOnly":true},"trades":{"description":"Contains information to support the dual process.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Trade name.","example":"Rogers"},"accountNumber":{"type":"string","example":"123-ABC-123"},"dateOpened":{"type":"string","format":"date"}}},"readOnly":true},"referenceData":{"description":"Extra data from the credit bureau.","readOnly":true,"type":"object","properties":{"singleSourceHit":{"description":"Single source hit.","type":"string","readOnly":true,"example":"Y"},"dualSourceHit":{"description":"Dual source hit.","type":"string","readOnly":true,"example":"Y"},"waterfallProcess":{"description":"Waterfall process.","type":"string","readOnly":true,"example":"Y"},"creditFileCreatedDate":{"description":"Date when the credit file is created.","type":"string","readOnly":true},"numberOfTradesOnFile":{"description":"Number of trades on file.","type":"string","readOnly":true,"example":"001"},"singleDecision":{"description":"Data related to a single source decision.","type":"object","allOf":[{"$ref":"#/components/schemas/CreditFileCommonDecisionData"}]},"dualDecision":{"description":"Data related to a dual source decision.","type":["array","null"],"items":{"allOf":[{"$ref":"#/components/schemas/CreditFileCommonDecisionData"}]}}}}}}},"components/schemas/ProofOfCreditFileKycDocument":{"id":"components/schemas/ProofOfCreditFileKycDocument","kind":"json-schema","title":"KYC documents.","data":{"title":"KYC documents.","type":"object","required":["customerId","documentType","status","fileIds"],"properties":{"id":{"type":"string","readOnly":true,"description":"ID of the KYC document.","maxLength":50,"example":"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"},"fileIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDs of linked file objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploaded "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" files must have the following tags attached to be used for KYC purposes:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"['kyc', 'id-front']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"['kyc', 'id-back']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"['kyc', 'face-proof']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permitted file types for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" files: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"string","maxLength":50,"example":"file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"}},"documentType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document type submitted for validation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" types are analyzed automatically."},"children":[]}]}]}],"$ref":"#/components/schemas/KycDocumentTypes"},"documentSubtype":{"description":"Document subtype submitted for validation.","$ref":"#/components/schemas/KycDocumentSubtypes"},"status":{"description":"Status of the validation.","type":"string","readOnly":true,"enum":["pending","in-progress","accepted","rejected","archived"],"x-enumDescriptions":{"pending":"Waiting to be reviewed or analyzed.","in-progress":"Being analyzed by the Rebilly AI.","accepted":"Accepted by AI or a human.","rejected":"Rejected by AI or a human.","archived":"Archived by the Rebilly AI."}},"rejectionReason":{"$ref":"#/components/schemas/KycDocumentRejection"},"requestId":{"readOnly":true,"type":["string","null"],"description":"ID of the KYC request.","maxLength":50,"example":"4f6cf35x-2c4y-483z-a0a9-158621f77a21"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"processedTime":{"description":"Date and time when the KYC document is processed.","type":["string","null"],"format":"date-time","readOnly":true},"customerId":{"$ref":"#/components/schemas/CustomerId"},"reviewerId":{"description":"ID of the KYC document reviewer.","type":["string","null"],"readOnly":true,"maxLength":50,"example":"44433322-2c4y-483z-a0a9-158621f77a21"},"reviewerName":{"description":"First and last name of the KYC document reviewer.","type":["string","null"],"readOnly":true},"reviewStartTime":{"description":"Date and time when the manual review starts.","type":["string","null"],"format":"date-time","readOnly":true},"reviewTime":{"description":"Date and time of manual review.","type":["string","null"],"format":"date-time","readOnly":true},"notes":{"description":"Reviewer notes.","type":["string","null"]},"tags":{"description":"List of KYC document tags.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"reason":{"description":"Reason for uploading.","type":["string","null"]},"matchLevel":{"$ref":"#/components/schemas/KycDocumentMatchLevels"},"settings":{"description":"Settings used to score the document.","type":["object","null"]},"revision":{"description":"Number of times the KYC document data has been modified.\n\nUse this value when analyzing webhook data to determine if a change must take precedence over the current representation.","type":"integer","readOnly":true},"documentMatches":{"description":"Proof of credit document matches.","type":["object","null"],"readOnly":true,"properties":{"version":{"$ref":"#/components/schemas/KycDocumentMatchesVersion"},"score":{"$ref":"#/components/schemas/KycDocumentMatchesScore"},"checkList":{"$ref":"#/components/schemas/KycDocumentCheckList"},"data":{"$ref":"#/components/schemas/CreditFileMatches"}}},"parsedData":{"type":["object","null"],"readOnly":true,"description":"Parsed data.","properties":{"version":{"$ref":"#/components/schemas/KycDocumentMatchesVersion"},"score":{"$ref":"#/components/schemas/KycDocumentMatchesScore"},"checkList":{"$ref":"#/components/schemas/KycDocumentCheckList"},"data":{"$ref":"#/components/schemas/CreditFileMatches"}}},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","customer"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"type":"object"},"files":{"type":"array","maxItems":3,"description":"Linked files."}}}}}},"components/schemas/KycDocument":{"id":"components/schemas/KycDocument","kind":"json-schema","title":"KycDocument","data":{"type":"object","description":"KYC document information.","discriminator":{"propertyName":"documentType","mapping":{"identity-proof":"#/components/schemas/ProofOfIdentityKycDocument","address-proof":"#/components/schemas/ProofOfAddressKycDocument","funds-proof":"#/components/schemas/ProofOfFundsKycDocument","purchase-proof":"#/components/schemas/ProofOfPurchaseKycDocument","credit-file-proof":"#/components/schemas/ProofOfCreditFileKycDocument"}},"oneOf":[{"$ref":"#/components/schemas/ProofOfIdentityKycDocument"},{"$ref":"#/components/schemas/ProofOfAddressKycDocument"},{"$ref":"#/components/schemas/ProofOfFundsKycDocument"},{"$ref":"#/components/schemas/ProofOfPurchaseKycDocument"},{"$ref":"#/components/schemas/ProofOfCreditFileKycDocument"}]}},"components/schemas/KycIdentityMatchesOverwrite":{"id":"components/schemas/KycIdentityMatchesOverwrite","kind":"json-schema","title":"KycIdentityMatchesOverwrite","data":{"type":"object","description":"Request body for overwriting identity KYC document matches.","allOf":[{"type":"object","required":["type"],"properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of KYC document matches."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value identifies the document match type as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["identity-proof"],"example":"identity-proof"}}},{"$ref":"#/components/schemas/KycIdentityMatches"}]}},"components/schemas/KycAddressMatchesOverwrite":{"id":"components/schemas/KycAddressMatchesOverwrite","kind":"json-schema","title":"KycAddressMatchesOverwrite","data":{"type":"object","description":"Request body for overwriting address KYC document matches.","allOf":[{"type":"object","required":["type"],"properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of KYC document matches."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value identifies the document match type as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["address-proof"],"example":"address-proof"}}},{"$ref":"#/components/schemas/KycAddressMatches"}]}},"components/schemas/KycPurchaseMatchesOverwrite":{"id":"components/schemas/KycPurchaseMatchesOverwrite","kind":"json-schema","title":"KycPurchaseMatchesOverwrite","data":{"type":"object","description":"Request body for overwriting purchase KYC document matches.","allOf":[{"type":"object","required":["type"],"properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of KYC document matches."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value identifies the document match type as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchase-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["purchase-proof"],"example":"purchase-proof"}}},{"$ref":"#/components/schemas/PurchaseMatches"}]}},"components/schemas/KycFundsMatchesOverwrite":{"id":"components/schemas/KycFundsMatchesOverwrite","kind":"json-schema","title":"KycFundsMatchesOverwrite","data":{"type":"object","description":"Request body for overwriting funds KYC document matches.","allOf":[{"type":"object","required":["type"],"properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of KYC document matches."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value identifies the document match type as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funds-proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["funds-proof"],"example":"funds-proof"}}},{"$ref":"#/components/schemas/FundsMatches"}]}},"components/schemas/KycSettings":{"id":"components/schemas/KycSettings","kind":"json-schema","title":"KycSettings","data":{"type":"object","description":"Settings for KYC score calculation.","properties":{"identityProof":{"$ref":"#/components/schemas/KycSettingsIdentity"},"addressProof":{"$ref":"#/components/schemas/KycSettingsAddress"},"uiVersion":{"description":"Version of the KYC document gatherer UI.","type":["string","null"],"enum":["1","2"],"default":"1","x-enumDescriptions":{"1":"Classic design.","2":"Modern design, optimized for the best user experience on both mobile and desktop devices."}}}}},"components/schemas/ResetPasswordToken":{"id":"components/schemas/ResetPasswordToken","kind":"json-schema","title":"ResetPasswordToken","data":{"type":"object","required":["username"],"properties":{"token":{"description":"ID of the token.","type":"string","readOnly":true},"username":{"description":"Username associated with the token.","type":"string"},"credentialId":{"description":"Credential ID associated with the token.","type":"string","readOnly":true},"expiredTime":{"description":"Date and time when the password expires.","type":["string","null"],"format":"date-time"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/PaymentCardBrand":{"id":"components/schemas/PaymentCardBrand","kind":"json-schema","title":"PaymentCardBrand","data":{"description":"Brand of payment card.","type":"string","enum":["Visa","MasterCard","American Express","Discover","Maestro","Solo","Electron","JCB","Voyager","Diners Club","Switch","Laser","China UnionPay","AstroPay Card"]}},"components/schemas/UseAsBackup":{"id":"components/schemas/UseAsBackup","kind":"json-schema","title":"UseAsBackup","data":{"description":"Specifies if this payment instrument can be used as a backup for invoice payment retries.","type":"boolean","default":false}},"components/schemas/LastPaymentTime":{"id":"components/schemas/LastPaymentTime","kind":"json-schema","title":"LastPaymentTime","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time of the last approved payment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments are the result of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions."},"children":[]}]}]}],"type":["string","null"],"format":"date-time","readOnly":true,"x-sortable":true,"x-label":"Last Payment Time"}},"components/schemas/PaymentCard":{"id":"components/schemas/PaymentCard","kind":"json-schema","title":"Payment card","data":{"type":"object","description":"Payment card information.","title":"Payment card","required":["method"],"properties":{"id":{"type":"string","description":"ID of the payment instrument.","readOnly":true,"maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"method":{"description":"Method of payment instrument.","type":"string","readOnly":true,"enum":["payment-card"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the payment instrument."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status means that a payment instrument has been used at least once for an approved transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To remove an instrument from use, set this value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deactivated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"./PostPaymentInstrumentDeactivation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivate a payment instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["active","inactive","expired","deactivated","verification-needed"]},"fingerprint":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique value that is used to identify the payment instrument."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is generated from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value contains alphanumeric characters."},"children":[]}]}]}],"type":"string","readOnly":true},"bin":{"description":"Bank Identification Number (BIN) of the payment card.\nThis value is the same as the first 6 digits of the associated Primary Account Number (PAN).","type":"string","format":"bin","readOnly":true},"last4":{"description":"Last 4 digits of the associated Primary Account Number (PAN).","type":"string","readOnly":true},"fpanLast4":{"description":"Last 4 digits of the Funding Primary Account Number (FPAN) of the payment card.\nThis value is only present for payment cards created from digital wallet tokens,\nwhere the FPAN is the physical card number visible to the cardholder,\nas opposed to the Device Primary Account Number (DPAN) used in the digital wallet transaction.","type":["string","null"],"readOnly":true},"pan":{"description":"Primary Account Number (PAN) of the payment card.","type":"string","writeOnly":true},"expYear":{"description":"Expiration year of the payment card.","type":"integer"},"expMonth":{"description":"Expiration month of the payment card.","type":"integer"},"cvv":{"description":"Card Verification Value (CVV) of the payment card.","type":"string","writeOnly":true},"brand":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/PaymentCardBrand"}]},"bankCountry":{"description":"Bank country of the payment instrument.","type":["string","null"],"readOnly":true},"bankName":{"description":"Bank name of the payment instrument.","type":"string","readOnly":true},"isPayoutable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if payouts are supported for cards with this BIN."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the BIN does not support payouts."},"children":[]}]}]}],"type":"boolean","readOnly":true},"billingAddress":{"description":"Contact's billing address.","$ref":"#/components/schemas/ContactObject"},"useAsBackup":{"$ref":"#/components/schemas/UseAsBackup"},"billingPortalUrl":{"description":"URL of the billing portal where the card can be updated.","type":"string","readOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"lastPaymentTime":{"$ref":"#/components/schemas/LastPaymentTime"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"stickyGatewayAccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the sticky gateway account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All future payments are processed by this gateway account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/intelligent-payment-routing/#sticky-gateway-accounts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"readOnly":true},"expirationReminderTime":{"description":"Date and time when an expiration reminder event is triggered.","type":["string","null"],"format":"date-time","readOnly":true},"expirationReminderNumber":{"description":"Number of expiration reminder events that have triggered.","type":["integer","null"],"readOnly":true},"referenceData":{"description":"Payment instrument reference data.","type":"object","additionalProperties":{"type":"string"},"example":{"gatewayTransactionId":"GAT123"}},"digitalWallet":{"readOnly":true,"description":"Digital wallet type.","type":["string","null"],"enum":["Apple Pay","Google Pay","Samsung Pay",null]},"riskMetadata":{"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"revision":{"description":"Number of times the payment instrument data has been modified.\n\nUse this value when analyzing webhook data to determine if a change must take precedence over the current representation.","type":"integer","readOnly":true},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","customer"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"type":"object"}}}}}},"components/schemas/BankAccount":{"id":"components/schemas/BankAccount","kind":"json-schema","title":"Bank account","data":{"type":"object","title":"Bank account","required":["method"],"properties":{"id":{"type":"string","description":"ID of the payment instrument.","readOnly":true,"maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"method":{"description":"Method of payment instrument.","type":"string","readOnly":true,"enum":["ach"]},"bankName":{"description":"Name of the bank.","type":"string"},"routingNumber":{"description":"Bank routing number.","type":"string"},"accountNumberType":{"description":"Type of bank account number.\nA valid value is a Basic Bank Account Number (BBAN) or an International Bank Account Number (IBAN).","type":"string","default":"BBAN","enum":["BBAN","IBAN"]},"accountType":{"description":"Type of bank account.","type":"string","enum":["checking","savings","other"]},"bic":{"description":"Bank Identifier Code (BIC).","type":["string","null"]},"billingAddress":{"description":"Customer's billing address.","$ref":"#/components/schemas/ContactObject"},"fingerprint":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique value which identifies the bank account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value contains alphanumeric characters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the type of bank account number,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a bank account fingerprint is generated using one of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BBAN: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"routingNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN: First 8 characters of the IBAN and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]}],"type":"string","readOnly":true},"last4":{"description":"Last 4 digits of the bank account number.","type":"string","readOnly":true},"status":{"description":"Status of the bank account.","type":"string","readOnly":true,"enum":["active","deactivated"]},"stickyGatewayAccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the sticky gateway account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All future payments are processed by this gateway account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/intelligent-payment-routing/#sticky-gateway-accounts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"readOnly":true},"riskMetadata":{"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"useAsBackup":{"$ref":"#/components/schemas/UseAsBackup"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"lastPaymentTime":{"$ref":"#/components/schemas/LastPaymentTime"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"revision":{"description":"Number of times the payment instrument data has been modified.\n\nUse this value when analyzing webhook data to determine if a change must take precedence over the current representation.","type":"integer","readOnly":true},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","customer"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"type":"object"}}}}}},"components/schemas/PayPalAccount":{"id":"components/schemas/PayPalAccount","kind":"json-schema","title":"PayPal account","data":{"type":"object","title":"PayPal account","required":["method","customerId","billingAddress"],"properties":{"id":{"type":"string","description":"ID of the payment instrument.","readOnly":true,"maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"method":{"description":"Method of payment instrument.","type":"string","enum":["paypal"]},"billingAddress":{"description":"Billing address.","$ref":"#/components/schemas/ContactObject"},"username":{"description":"PayPal username.","type":"string","readOnly":true},"status":{"description":"PayPal account status.","type":"string","readOnly":true,"enum":["inactive","active","deactivated"]},"useAsBackup":{"$ref":"#/components/schemas/UseAsBackup"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"lastPaymentTime":{"$ref":"#/components/schemas/LastPaymentTime"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"stickyGatewayAccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the sticky gateway account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All future payments are processed by this gateway account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/intelligent-payment-routing/#sticky-gateway-accounts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"readOnly":true},"riskMetadata":{"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"revision":{"description":"Number of times the payment instrument data has been modified.\n\nUse this value when analyzing webhook data to determine if a change must take precedence over the current representation.","type":"integer","readOnly":true},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","customer"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"type":"object"}}}}}},"components/schemas/KhelocardCard":{"id":"components/schemas/KhelocardCard","kind":"json-schema","title":"Khelocard card","data":{"type":"object","title":"Khelocard card","required":["method"],"properties":{"id":{"type":"string","description":"ID of the payment instrument.","readOnly":true,"maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"method":{"description":"Method of payment instrument.","type":"string","enum":["Khelocard"]},"fingerprint":{"description":"Unique value which identifies the payment instrument.\nThis value contains alphanumeric characters.\nThis value is generated from the card number, CVV, and expiration date.","type":"string"},"number":{"description":"Khelocard card masked number.","type":"string"},"last4":{"description":"Last 4 digits of the number.","type":"string"},"expYear":{"description":"Khelocard card expiration year.","type":"integer"},"expMonth":{"description":"Khelocard card expiration month.","type":"integer"},"billingAddress":{"description":"Billing address.","$ref":"#/components/schemas/ContactObject"},"status":{"description":"Payment instrument status.","type":"string","enum":["active","deactivated"]},"useAsBackup":{"$ref":"#/components/schemas/UseAsBackup"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"lastPaymentTime":{"$ref":"#/components/schemas/LastPaymentTime"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"stickyGatewayAccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the sticky gateway account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All future payments are processed by this gateway account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/intelligent-payment-routing/#sticky-gateway-accounts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"readOnly":true},"riskMetadata":{"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"revision":{"description":"Number of times the payment instrument data has been modified.\n\nUse this value when analyzing webhook data to determine if a change must take precedence over the current representation.","type":"integer","readOnly":true},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","customer"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"type":"object"}}}}}},"components/schemas/AlternativePaymentMethods":{"id":"components/schemas/AlternativePaymentMethods","kind":"json-schema","title":"AlternativePaymentMethods","data":{"type":"string","description":"Payment method.","enum":["cash","check","paypal","AdvCash","Aera","Affirm","Afterpay","Aircash","Alfa-click","Alipay","AstroPay Card","AstroPay-GO","BankReferenced","bank-transfer","bank-transfer-2","bank-transfer-3","bank-transfer-4","bank-transfer-5","bank-transfer-6","bank-transfer-7","bank-transfer-8","bank-transfer-9","Baloto","Beeline","Belfius-direct-net","bitcoin","Bizum","Boleto","cash-deposit","CASHlib","CashToCode","China UnionPay","Clearpay","Cleo","CODVoucher","Conekta-oxxo","Cupon-de-pagos","cryptocurrency","domestic-cards","Directa24Card","echeck","ecoPayz","ecoPayzTurkey","ecoVoucher","Efecty","EPS","ePay.bg","eZeeWallet","FasterPay","Flexepin","Giropay","Gpaysafe","Google Pay","iDebit","iDEAL","ING-homepay","INOVAPAY-pin","INOVAPAY-wallet","InstaDebit","instant-bank-transfer","InstantPayments","Interac","Interac-online","Interac-eTransfer","invoice","iWallet","Jeton","JetonCash","jpay","KakaoPay","Khelocard","Klarna","KNOT","loonie","Matrix","MaxiCash","Megafon","MercadoPago","MiFinity-eWallet","miscellaneous","MobilePay","Bancontact","Bancontact-mobile","MTS","Mollie","MuchBetter","MuchBetterVoucher","Multibanco","Neosurf","Netbanking","Neteller","Nordea-Solo","OchaPay","online-bank-transfer","Onlineueberweisen","oriental-wallet","OXXO","P24","Pagadito","PagoEffectivo","Pagsmile-deposit-express","Pagsmile-lottery","PayCash","Payco","Payeer","PaymentAsia-crypto","Paymero","Perfect-money","Piastrix","PIX","PIX-Automatico","plaid-account","PayTabs","Paysafecard","Paysafecash","Pay4Fun","Paynote","PinPay","phone","PhonePe","POLi","PostFinance-card","PostFinance-e-finance","QIWI","QPay","QQPay","Quickpay","rapyd-checkout","Resurs","SafetyPay","Samsung Pay","SEPA","Skrill","Skrill Rapid Transfer","SMSVoucher","Sofort","SparkPay","swift-dbt","Tele2","Terminaly-RF","ToditoCash-card","Trustly","Tupay","UPayCard","UPI","USD-coin","VCreditos","VegaWallet","VenusPoint","Viva","voucher","voucher-2","voucher-3","voucher-4","Wallet88","Webmoney","Webpay","Webpay-2","Webpay Card","WeChat Pay","wire","XPay-P2P","XPay-QR","Yandex-money","Zotapay","Zimpler","Zip"]}},"components/schemas/AlternativeInstrument":{"id":"components/schemas/AlternativeInstrument","kind":"json-schema","title":"Alternative instrument","data":{"type":"object","title":"Alternative instrument","required":["method","customerId","billingAddress"],"properties":{"id":{"type":"string","description":"ID of the payment instrument.","readOnly":true,"maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"method":{"description":"Payment method of the payment instrument.","allOf":[{"$ref":"#/components/schemas/AlternativePaymentMethods"},{"not":{"enum":["payment-card","paypal","ach","echeck","Khelocard"]}}]},"billingAddress":{"description":"Billing address of the user that is associated with the payment instrument.","$ref":"#/components/schemas/ContactObject"},"status":{"description":"Payment instrument status.","type":"string","readOnly":true,"enum":["active","deactivated"]},"useAsBackup":{"$ref":"#/components/schemas/UseAsBackup"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"lastPaymentTime":{"$ref":"#/components/schemas/LastPaymentTime"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"stickyGatewayAccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the sticky gateway account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All future payments are processed by this gateway account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/intelligent-payment-routing/#sticky-gateway-accounts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"readOnly":true},"referenceData":{"description":"Payment instrument reference data.","type":"object","additionalProperties":{"type":"string"},"example":{"gatewayTransactionId":"GAT123"}},"riskMetadata":{"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"revision":{"description":"Number of times the payment instrument data has been modified.\n\nUse this value when analyzing webhook data to determine if a change must take precedence over the current representation.","type":"integer","readOnly":true},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","customer"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"type":"object"}}}}}},"components/schemas/PaymentInstrument":{"id":"components/schemas/PaymentInstrument","kind":"json-schema","title":"PaymentInstrument","data":{"discriminator":{"propertyName":"method","mapping":{"payment-card":"#/components/schemas/PaymentCard","ach":"#/components/schemas/BankAccount","paypal":"#/components/schemas/PayPalAccount","Khelocard":"#/components/schemas/KhelocardCard","cash":"#/components/schemas/AlternativeInstrument","check":"#/components/schemas/AlternativeInstrument","AdvCash":"#/components/schemas/AlternativeInstrument","Alfa-click":"#/components/schemas/AlternativeInstrument","Alipay":"#/components/schemas/AlternativeInstrument","AstroPay Card":"#/components/schemas/AlternativeInstrument","AstroPay-GO":"#/components/schemas/AlternativeInstrument","BankReferenced":"#/components/schemas/AlternativeInstrument","bank-transfer":"#/components/schemas/AlternativeInstrument","bank-transfer-2":"#/components/schemas/AlternativeInstrument","bank-transfer-3":"#/components/schemas/AlternativeInstrument","bank-transfer-4":"#/components/schemas/AlternativeInstrument","bank-transfer-5":"#/components/schemas/AlternativeInstrument","bank-transfer-6":"#/components/schemas/AlternativeInstrument","bank-transfer-7":"#/components/schemas/AlternativeInstrument","bank-transfer-8":"#/components/schemas/AlternativeInstrument","bank-transfer-9":"#/components/schemas/AlternativeInstrument","Baloto":"#/components/schemas/AlternativeInstrument","Beeline":"#/components/schemas/AlternativeInstrument","Belfius-direct-net":"#/components/schemas/AlternativeInstrument","bitcoin":"#/components/schemas/AlternativeInstrument","Bizum":"#/components/schemas/AlternativeInstrument","Boleto":"#/components/schemas/AlternativeInstrument","cash-deposit":"#/components/schemas/AlternativeInstrument","CASHlib":"#/components/schemas/AlternativeInstrument","CashToCode":"#/components/schemas/AlternativeInstrument","China UnionPay":"#/components/schemas/AlternativeInstrument","Cleo":"#/components/schemas/AlternativeInstrument","CODVoucher":"#/components/schemas/AlternativeInstrument","Conekta-oxxo":"#/components/schemas/AlternativeInstrument","Cupon-de-pagos":"#/components/schemas/AlternativeInstrument","cryptocurrency":"#/components/schemas/AlternativeInstrument","domestic-cards":"#/components/schemas/AlternativeInstrument","ecoPayz":"#/components/schemas/AlternativeInstrument","ecoVoucher":"#/components/schemas/AlternativeInstrument","Efecty":"#/components/schemas/AlternativeInstrument","EPS":"#/components/schemas/AlternativeInstrument","ePay.bg":"#/components/schemas/AlternativeInstrument","eZeeWallet":"#/components/schemas/AlternativeInstrument","FasterPay":"#/components/schemas/AlternativeInstrument","Flexepin":"#/components/schemas/AlternativeInstrument","Giropay":"#/components/schemas/AlternativeInstrument","Gpaysafe":"#/components/schemas/AlternativeInstrument","Google Pay":"#/components/schemas/AlternativeInstrument","iDebit":"#/components/schemas/AlternativeInstrument","iDEAL":"#/components/schemas/AlternativeInstrument","ING-homepay":"#/components/schemas/AlternativeInstrument","INOVAPAY-pin":"#/components/schemas/AlternativeInstrument","INOVAPAY-wallet":"#/components/schemas/AlternativeInstrument","InstaDebit":"#/components/schemas/AlternativeInstrument","instant-bank-transfer":"#/components/schemas/AlternativeInstrument","InstantPayments":"#/components/schemas/AlternativeInstrument","Interac":"#/components/schemas/AlternativeInstrument","Interac-online":"#/components/schemas/AlternativeInstrument","Interac-eTransfer":"#/components/schemas/AlternativeInstrument","invoice":"#/components/schemas/AlternativeInstrument","iWallet":"#/components/schemas/AlternativeInstrument","Jeton":"#/components/schemas/AlternativeInstrument","jpay":"#/components/schemas/AlternativeInstrument","Klarna":"#/components/schemas/AlternativeInstrument","KNOT":"#/components/schemas/AlternativeInstrument","loonie":"#/components/schemas/AlternativeInstrument","Matrix":"#/components/schemas/AlternativeInstrument","MaxiCash":"#/components/schemas/AlternativeInstrument","Megafon":"#/components/schemas/AlternativeInstrument","MiFinity-eWallet":"#/components/schemas/AlternativeInstrument","miscellaneous":"#/components/schemas/AlternativeInstrument","Bancontact":"#/components/schemas/AlternativeInstrument","Bancontact-mobile":"#/components/schemas/AlternativeInstrument","MTS":"#/components/schemas/AlternativeInstrument","MuchBetter":"#/components/schemas/AlternativeInstrument","Multibanco":"#/components/schemas/AlternativeInstrument","Neosurf":"#/components/schemas/AlternativeInstrument","Netbanking":"#/components/schemas/AlternativeInstrument","Neteller":"#/components/schemas/AlternativeInstrument","Nordea-Solo":"#/components/schemas/AlternativeInstrument","OchaPay":"#/components/schemas/AlternativeInstrument","online-bank-transfer":"#/components/schemas/AlternativeInstrument","Onlineueberweisen":"#/components/schemas/AlternativeInstrument","oriental-wallet":"#/components/schemas/AlternativeInstrument","OXXO":"#/components/schemas/AlternativeInstrument","P24":"#/components/schemas/AlternativeInstrument","Pagadito":"#/components/schemas/AlternativeInstrument","PagoEffectivo":"#/components/schemas/AlternativeInstrument","Pagsmile-deposit-express":"#/components/schemas/AlternativeInstrument","Pagsmile-lottery":"#/components/schemas/AlternativeInstrument","PayCash":"#/components/schemas/AlternativeInstrument","Payeer":"#/components/schemas/AlternativeInstrument","PaymentAsia-crypto":"#/components/schemas/AlternativeInstrument","Paymero":"#/components/schemas/AlternativeInstrument","Perfect-money":"#/components/schemas/AlternativeInstrument","Piastrix":"#/components/schemas/AlternativeInstrument","plaid-account":"#/components/schemas/AlternativeInstrument","PayTabs":"#/components/schemas/AlternativeInstrument","Paysafecard":"#/components/schemas/AlternativeInstrument","Paysafecash":"#/components/schemas/AlternativeInstrument","Pay4Fun":"#/components/schemas/AlternativeInstrument","Paynote":"#/components/schemas/AlternativeInstrument","PinPay":"#/components/schemas/AlternativeInstrument","phone":"#/components/schemas/AlternativeInstrument","PhonePe":"#/components/schemas/AlternativeInstrument","POLi":"#/components/schemas/AlternativeInstrument","PostFinance-card":"#/components/schemas/AlternativeInstrument","PostFinance-e-finance":"#/components/schemas/AlternativeInstrument","QIWI":"#/components/schemas/AlternativeInstrument","QPay":"#/components/schemas/AlternativeInstrument","QQPay":"#/components/schemas/AlternativeInstrument","rapyd-checkout":"#/components/schemas/AlternativeInstrument","Resurs":"#/components/schemas/AlternativeInstrument","SafetyPay":"#/components/schemas/AlternativeInstrument","SEPA":"#/components/schemas/AlternativeInstrument","Skrill":"#/components/schemas/AlternativeInstrument","Skrill Rapid Transfer":"#/components/schemas/AlternativeInstrument","SMSVoucher":"#/components/schemas/AlternativeInstrument","Sofort":"#/components/schemas/AlternativeInstrument","SparkPay":"#/components/schemas/AlternativeInstrument","swift-dbt":"#/components/schemas/AlternativeInstrument","Tele2":"#/components/schemas/AlternativeInstrument","Terminaly-RF":"#/components/schemas/AlternativeInstrument","ToditoCash-card":"#/components/schemas/AlternativeInstrument","Trustly":"#/components/schemas/AlternativeInstrument","UPayCard":"#/components/schemas/AlternativeInstrument","UPI":"#/components/schemas/AlternativeInstrument","USD-coin":"#/components/schemas/AlternativeInstrument","VCreditos":"#/components/schemas/AlternativeInstrument","VenusPoint":"#/components/schemas/AlternativeInstrument","voucher":"#/components/schemas/AlternativeInstrument","voucher-2":"#/components/schemas/AlternativeInstrument","voucher-3":"#/components/schemas/AlternativeInstrument","voucher-4":"#/components/schemas/AlternativeInstrument","Webmoney":"#/components/schemas/AlternativeInstrument","Webpay":"#/components/schemas/AlternativeInstrument","Webpay-2":"#/components/schemas/AlternativeInstrument","Webpay Card":"#/components/schemas/AlternativeInstrument","WeChat Pay":"#/components/schemas/AlternativeInstrument","XPay-P2P":"#/components/schemas/AlternativeInstrument","XPay-QR":"#/components/schemas/AlternativeInstrument","Yandex-money":"#/components/schemas/AlternativeInstrument","Zotapay":"#/components/schemas/AlternativeInstrument","Zimpler":"#/components/schemas/AlternativeInstrument"}},"oneOf":[{"$ref":"#/components/schemas/PaymentCard"},{"$ref":"#/components/schemas/BankAccount"},{"$ref":"#/components/schemas/PayPalAccount"},{"$ref":"#/components/schemas/KhelocardCard"},{"$ref":"#/components/schemas/AlternativeInstrument"}]}},"components/schemas/PaymentInstrumentCreateToken":{"id":"components/schemas/PaymentInstrumentCreateToken","kind":"json-schema","title":"Payment token","data":{"title":"Payment token","type":"object","required":["customerId","token"],"properties":{"customerId":{"$ref":"#/components/schemas/CustomerId"},"token":{"description":"ID of the payment token.","type":"string"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"useAsBackup":{"$ref":"#/components/schemas/UseAsBackup"}}}},"components/schemas/PaymentCardCreatePlain":{"id":"components/schemas/PaymentCardCreatePlain","kind":"json-schema","title":"Payment card","data":{"title":"Payment card","type":"object","required":["method","customerId","pan","expYear","expMonth","billingAddress"],"properties":{"method":{"description":"Method of the payment instrument.","type":"string","enum":["payment-card"]},"customerId":{"$ref":"#/components/schemas/CustomerId"},"pan":{"description":"Primary Account Number (PAN) of the payment card.","type":"string","writeOnly":true},"expYear":{"description":"Expiration year of the payment card.","type":"integer"},"expMonth":{"description":"Expiration month of the payment card.","type":"integer"},"cvv":{"description":"Card Verification Value (CVV) of the payment card.","type":"string","writeOnly":true},"billingAddress":{"description":"Billing address.","$ref":"#/components/schemas/ContactObject"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"riskMetadata":{"$ref":"#/components/schemas/RiskMetadata"},"useAsBackup":{"$ref":"#/components/schemas/UseAsBackup"}}}},"components/schemas/BBANType":{"id":"components/schemas/BBANType","kind":"json-schema","title":"BBANType","data":{"type":"object","description":"BBAN type object.","required":["accountNumberType","method","customerId","accountNumber","routingNumber","accountType","billingAddress"],"properties":{"method":{"description":"Payment method of the payment instrument.","type":"string","enum":["ach"]},"customerId":{"$ref":"#/components/schemas/CustomerId"},"accountNumberType":{"description":"Type of the customer's bank account number.\nA valid value is a Basic Bank Account Number (BBAN) or an International Bank Account Number (IBAN).","type":"string","enum":["BBAN"]},"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's bank account number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detailed information on all ISO 13616-compliant national IBAN formats is available in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.swift.com/standards/data-standards/iban"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SWIFT IBAN Registry"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[0-9]+$","example":"1234567890"},"routingNumber":{"description":"Bank routing number.","type":"string","pattern":"^[0-9]+$","example":"123456789"},"accountType":{"description":"Type of the bank account.","type":"string","enum":["checking","savings","other"]},"bankName":{"description":"Name of the bank.","type":"string"},"bic":{"description":"Bank Identifier Code (BIC).","type":"string"},"billingAddress":{"description":"Customer's billing address.","$ref":"#/components/schemas/ContactObject"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"riskMetadata":{"$ref":"#/components/schemas/RiskMetadata"},"useAsBackup":{"$ref":"#/components/schemas/UseAsBackup"}}}},"components/schemas/IBANType":{"id":"components/schemas/IBANType","kind":"json-schema","title":"IBANType","data":{"type":"object","description":"IBAN type object.","required":["accountNumberType","method","customerId","accountNumber","billingAddress"],"properties":{"method":{"description":"Payment method of the payment instrument.","type":"string","enum":["ach"]},"customerId":{"$ref":"#/components/schemas/CustomerId"},"accountNumberType":{"description":"Type of the customer's bank account number.\nA valid value is a Basic Bank Account Number (BBAN) or an International Bank Account Number (IBAN).","type":"string","enum":["IBAN"]},"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's bank account number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detailed information on all ISO 13616-compliant national IBAN formats is available in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.swift.com/standards/data-standards/iban"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SWIFT IBAN Registry"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"DE89370400440532013000"},"bankName":{"description":"Name of the bank.","type":"string"},"bic":{"description":"Bank Identifier Code (BIC).","type":"string","example":"DEUTDE8LXXX"},"billingAddress":{"description":"Customer's billing address.","$ref":"#/components/schemas/ContactObject"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"riskMetadata":{"$ref":"#/components/schemas/RiskMetadata"},"useAsBackup":{"$ref":"#/components/schemas/UseAsBackup"}}}},"components/schemas/BankAccountCreatePlain":{"id":"components/schemas/BankAccountCreatePlain","kind":"json-schema","title":"Bank account","data":{"title":"Bank account","type":"object","required":["accountNumberType"],"discriminator":{"propertyName":"accountNumberType","mapping":{"BBAN":"#/components/schemas/BBANType","IBAN":"#/components/schemas/IBANType"}},"oneOf":[{"$ref":"#/components/schemas/BBANType"},{"$ref":"#/components/schemas/IBANType"}]}},"components/schemas/PaymentInstrumentUpdateToken":{"id":"components/schemas/PaymentInstrumentUpdateToken","kind":"json-schema","title":"PaymentInstrumentUpdateToken","data":{"type":"object","properties":{"token":{"description":"ID of the payment token.","type":"string"},"billingAddress":{"description":"Customer's billing address.\nIf this value is supplied it overrides the billing address that is supplied with the token.","$ref":"#/components/schemas/ContactObject"},"stickyGatewayAccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the sticky gateway account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All future payments are processed by this gateway account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To remove the sticky gateway account from a payment instrument, set this value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/intelligent-payment-routing/#sticky-gateway-accounts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"maxLength":50,"example":"gw_acc_0YVCXMF26DDNKAERE5NW727S34"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"useAsBackup":{"$ref":"#/components/schemas/UseAsBackup"}}}},"components/schemas/PaymentCardUpdatePlain":{"id":"components/schemas/PaymentCardUpdatePlain","kind":"json-schema","title":"PaymentCardUpdatePlain","data":{"type":"object","properties":{"cvv":{"description":"Card Verification Value (CVV) of the payment card.","type":"string"},"expMonth":{"description":"Expiration month of the payment card.","type":"integer"},"expYear":{"description":"Expiration year of the payment card.","type":"integer"},"billingAddress":{"description":"Billing address.","$ref":"#/components/schemas/ContactObject"},"stickyGatewayAccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the sticky gateway account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All future payments are processed by this gateway account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/intelligent-payment-routing/#sticky-gateway-accounts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/ResourceId"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"useAsBackup":{"$ref":"#/components/schemas/UseAsBackup"}}}},"components/schemas/BankAccountUpdatePlain":{"id":"components/schemas/BankAccountUpdatePlain","kind":"json-schema","title":"BankAccountUpdatePlain","data":{"type":"object","properties":{"bankName":{"description":"Name of the bank.","type":"string"},"accountType":{"description":"Bank account type.","type":"string","enum":["checking","savings","other"]},"billingAddress":{"description":"Billing address.","$ref":"#/components/schemas/ContactObject"},"stickyGatewayAccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the sticky gateway account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All future payments are processed by this gateway account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/intelligent-payment-routing/#sticky-gateway-accounts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/ResourceId"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"useAsBackup":{"$ref":"#/components/schemas/UseAsBackup"}}}},"components/schemas/PaymentInstrumentNameInquiry":{"id":"components/schemas/PaymentInstrumentNameInquiry","kind":"json-schema","title":"PaymentInstrumentNameInquiry","data":{"type":"object","description":"Perform a name inquiry on a payment instrument.","required":["gatewayAccountId"],"properties":{"gatewayAccountId":{"description":"ID of the gateway account.","type":"string"},"result":{"description":"Result of the payment instrument name inquiry.","type":"string","readOnly":true,"enum":["full-match","partial-match","no-match","not-supported","unknown"]},"response":{"readOnly":true,"description":"Raw response message from gateway.","type":"string"}}}},"components/schemas/PlanFormulaFixedFee":{"id":"components/schemas/PlanFormulaFixedFee","kind":"json-schema","title":"Fixed-fee","data":{"title":"Fixed-fee","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixed-fee pricing details."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this formula for subscriptions that involve the same price,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number of units, and reoccur over a fixed period of time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/pricing-formulas/#fixed-fee-per-period"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixed-fee per period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","required":["price","formula"],"properties":{"formula":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price formula that determines which algorithm is used to calculate the invoice price based on the following factors:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity in the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value may be variable if you are charging based on usage."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are not charging based on usage,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this value is determined when an order is created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price of the quantity range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some formulas set a price based on defined product quantity ranges."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/billing/pricing-formulas/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price formulas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["fixed-fee"]},"price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this formula to charge for subscriptions that have a fixed price,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number of units, and reoccur over a fixed period of time,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"such as every: day, week, month, year, or number of years."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a streaming company charges customers $13.99 each month for subscription period that is 6 months in duration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The quantity of movies that a customer streams each month does not impact the price."},"children":[]}]}]}],"type":"number","format":"double","example":99.95}}}},"components/schemas/PlanFormulaFlatRate":{"id":"components/schemas/PlanFormulaFlatRate","kind":"json-schema","title":"Flat rate","data":{"title":"Flat rate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flat rate pricing details."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this formula to charge a flat fee per unit."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, $0.10 per transaction or $4 per unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/billing/pricing-formulas/#flat-rate-pricing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flat rate pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","required":["price","formula"],"properties":{"formula":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price formula that determines which algorithm is used to calculate the invoice price based on the following factors:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity in the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value may be variable if you are charging based on usage."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are not charging based on usage,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this value is determined when an order is created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price of the quantity range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some formulas set a price based on defined product quantity ranges."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/billing/pricing-formulas/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price formulas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["flat-rate"]},"price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this formula to charge a flat fee per unit."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, $0.10 for each transaction or $4 per unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the product is free."},"children":[]}]}]}],"type":"number","format":"double","example":99.95},"minQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum permitted unit quantity."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no limit is in place."},"children":[]}]}]}],"type":["integer","null"],"default":null,"example":1,"minimum":1,"maximum":999999999},"maxQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum permitted unit quantity."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no limit is in place."},"children":[]}]}]}],"type":["integer","null"],"example":1,"minimum":1,"maximum":999999999}}}},"components/schemas/PlanFormulaStairstep":{"id":"components/schemas/PlanFormulaStairstep","kind":"json-schema","title":"Stair-step","data":{"title":"Stair-step","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stair-step pricing details."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this formula to charge for units that are sold in specific quantities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/billing/pricing-formulas/#stair-step"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stair-step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","required":["brackets","formula"],"properties":{"formula":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price formula that determines which algorithm is used to calculate the invoice price based on the following factors:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity in the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value may be variable if you are charging based on usage."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are not charging based on usage,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this value is determined when an order is created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price of the quantity range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some formulas set a price based on defined product quantity ranges."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/billing/pricing-formulas/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price formulas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["stairstep"]},"brackets":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this formula to charge for units that are sold in specific quantity ranges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a bank charges a merchant based on the number of transactions they complete each month."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price total"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Max quantity"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$50"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1000"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 1000 transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$100"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Between 1000 and 1500 transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3000"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Between 1500 and 3000 transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"More than 3000 transactions"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the merchant completes 900 transaction in a month, they are charged $50."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the merchant completes 1001 transaction in a month, they are charged $100."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the merchant completes 2500 transaction in a month, they are charged $200."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the merchant completes more than 3000 transaction in a month, they are charged $500."},"children":[]}]}]}]}],"type":"array","minItems":1,"items":{"type":"object","properties":{"price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price of the quantity range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the product is free."},"children":[]}]}]}],"type":"number","format":"double","example":99.95},"maxQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum permitted unit quantity."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no limit is in place."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value starts from the end of the previous quantity range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there are no previous quantity ranges,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this value starts at 1."},"children":[]}]}]}],"type":["integer","null"],"example":1,"minimum":1,"maximum":999999999}}}},"minQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum permitted unit quantity."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no limit is in place."},"children":[]}]}]}],"type":["integer","null"],"default":null,"example":1,"minimum":1,"maximum":999999999}}}},"components/schemas/PlanFormulaTiered":{"id":"components/schemas/PlanFormulaTiered","kind":"json-schema","title":"Tiered","data":{"title":"Tiered","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tiered pricing details."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this formula to charge for units that are sold within defined quantity ranges, or tiers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/pricing-formulas/#tiered"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tiered"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","required":["brackets","formula"],"properties":{"formula":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price formula that determines which algorithm is used to calculate the invoice price based on the following factors:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity in the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value may be variable if you are charging based on usage."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are not charging based on usage,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this value is determined when an order is created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price of the quantity range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some formulas set a price based on defined product quantity ranges."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/billing/pricing-formulas/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price formulas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["tiered"]},"brackets":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this formula to charge for units that are sold within defined quantity ranges, or tiers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a customer buys a number of units that span more than one tier,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the total cost is calculated based on the cost of the units in each tier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a software company sells user licenses based on the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tier"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price per user"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Max quantity"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$40"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 to 3 user licenses"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$30"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5 to 8 user licenses"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$15"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"9 or more user licenses"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a customer buys 10 user licenses, the pricing is as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 licenses at tier 1 (3 x $40) is 120"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5 licenses at tier 2 (5 x $30) is 150"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 licenses at tier 3 (2 x $15) is 30"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total cost = $330"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Formula: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(price for the tier x quantity within the tier)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(price for next tier x quantity in next tier)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = final price."},"children":[]}]}]}],"type":"array","minItems":1,"items":{"type":"object","properties":{"price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price of the quantity range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the product is free."},"children":[]}]}]}],"type":"number","format":"double","example":99.95},"maxQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum permitted unit quantity."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no limit is in place."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value starts from the end of the previous quantity range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there are no previous quantity ranges,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this value starts at 1."},"children":[]}]}]}],"type":["integer","null"],"example":1,"minimum":1,"maximum":999999999}}}},"minQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum permitted unit quantity."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no limit is in place."},"children":[]}]}]}],"type":["integer","null"],"default":null,"example":1,"minimum":1,"maximum":999999999}}}},"components/schemas/PlanFormulaVolume":{"id":"components/schemas/PlanFormulaVolume","kind":"json-schema","title":"Volume","data":{"title":"Volume","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Volume pricing details."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this formula to charge for units that are sold in bulk,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or volume ranges. In general,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this formula means that a customer pays less per unit when they buy a large volume of units."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/pricing-formulas/#volume"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Volume"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","required":["brackets","formula"],"properties":{"formula":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price formula that determines which algorithm is used to calculate the invoice price based on the following factors:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity in the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value may be variable if you are charging based on usage."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are not charging based on usage,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this value is determined when an order is created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price of the quantity range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some formulas set a price based on defined product quantity ranges."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/billing/pricing-formulas/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price formulas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["volume"]},"brackets":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this formula to charge for units that are sold in bulk, or volume ranges."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This formula enables customers to pays less per unit when they buy a large volume of units."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit cost is based on the highest volume range, and does not include lower volume range pricing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a company sells t-shirts in the following volume ranges:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price per unit"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Max quantity"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$10"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 t-shirt"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$8"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 to 5 t-shirts"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6 or more t-shirts"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a customer buys 1 unit, they pay $10."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a customer buys 3 units, they pay $24 per unit, which is $8 per unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a customer buys 10 units, they pay $40, which is $4 per unit."},"children":[]}]}]}]}],"type":"array","minItems":1,"items":{"type":"object","properties":{"price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price of the quantity range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the product is free."},"children":[]}]}]}],"type":"number","format":"double","example":99.95},"maxQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum permitted unit quantity."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no limit is in place."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value starts from the end of the previous quantity range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there are no previous quantity ranges,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this value starts at 1."},"children":[]}]}]}],"type":["integer","null"],"example":1,"minimum":1,"maximum":999999999}}}},"minQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum permitted unit quantity."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no limit is in place."},"children":[]}]}]}],"type":["integer","null"],"default":null,"example":1,"minimum":1,"maximum":999999999}}}},"components/schemas/PlanPriceFormula":{"id":"components/schemas/PlanPriceFormula","kind":"json-schema","title":"PlanPriceFormula","data":{"description":"Pricing details.","type":"object","discriminator":{"propertyName":"formula","mapping":{"fixed-fee":"#/components/schemas/PlanFormulaFixedFee","flat-rate":"#/components/schemas/PlanFormulaFlatRate","stairstep":"#/components/schemas/PlanFormulaStairstep","tiered":"#/components/schemas/PlanFormulaTiered","volume":"#/components/schemas/PlanFormulaVolume"}},"oneOf":[{"$ref":"#/components/schemas/PlanFormulaFixedFee"},{"$ref":"#/components/schemas/PlanFormulaFlatRate"},{"$ref":"#/components/schemas/PlanFormulaStairstep"},{"$ref":"#/components/schemas/PlanFormulaTiered"},{"$ref":"#/components/schemas/PlanFormulaVolume"}]}},"components/schemas/PlanSetup":{"id":"components/schemas/PlanSetup","kind":"json-schema","title":"PlanSetup","data":{"type":["object","null"],"description":"Setup fee information for the plan.","required":["price"],"properties":{"price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One-time setup fee charged when the plan starts."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no setup fee applies."},"children":[]}]}]}],"type":"number","format":"double"}}}},"components/schemas/OneTimeSalePlan":{"id":"components/schemas/OneTimeSalePlan","kind":"json-schema","title":"OneTimeSalePlan","data":{"title":"OneTimeSalePlan","type":"object","description":"Details of the one-time sale plan.\nUse this plan for non-recurring, one-time, sales.","required":["name","currency","productId","pricing"],"properties":{"name":{"description":"Name of the plan.\nThis name is displayed on invoices and receipts.","type":"string","maxLength":255},"description":{"type":"string","description":"Plain-text description of the plan.\nThis field accepts plain-text only.","maxLength":65535},"richDescription":{"type":"string","description":"Rich-text description of the plan.\nThis field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks.","maxLength":65535},"productId":{"type":"string","description":"ID of the related product.","maxLength":50,"example":"prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"},"productOptions":{"type":["object","null"],"description":"Name-value pairs that specify the product options.","additionalProperties":{"type":"string"},"example":{"color":"red","size":"xxl"}},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"currencySign":{"description":"Currency sign.","readOnly":true,"type":"string"},"pricing":{"$ref":"#/components/schemas/PlanPriceFormula"},"setup":{"$ref":"#/components/schemas/PlanSetup"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"isActive":{"type":"boolean","description":"Specifies if the plan is active.","default":true},"revision":{"type":"integer","readOnly":true,"description":"Number of times the plan is modified.\nCompare this value with materialized subscription item revision values."},"isTrialOnly":{"type":"boolean","const":false,"description":"Specifies if a plan is a trial that does not have recurring instructions.","readOnly":true},"recurringInterval":{"type":"null","description":"Service interval settings.","readOnly":true},"trial":{"type":"null","description":"Trial configuration setting.","readOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","attachments"]}}}}}}},"components/schemas/SchedulingMethodDayAndMonthOfYear":{"id":"components/schemas/SchedulingMethodDayAndMonthOfYear","kind":"json-schema","title":"SchedulingMethodDayAndMonthOfYear","data":{"type":"object","properties":{"method":{"type":"string","enum":["day-and-month-of-year"]},"day":{"type":"integer","minimum":1,"maximum":31,"description":"Day of the month in which the event occurs.\nIf the month has less days, the last day of the month is selected."},"month":{"type":"integer","minimum":1,"maximum":12,"description":"Month of the year in which the event occurs."},"time":{"$ref":"#/components/schemas/TimeIso8601Extended"}},"required":["day","month","method"]}},"components/schemas/ServicePeriodAnchorInstruction":{"id":"components/schemas/ServicePeriodAnchorInstruction","kind":"json-schema","title":"ServicePeriodAnchorInstruction","data":{"type":["object","null"],"description":"Instruction for calculating the service period anchor.\n\nThe service period anchor is used, in conjunction with the subscription\nstart time, to calculate when the service period starts and ends.","discriminator":{"propertyName":"method","mapping":{"day-of-month":"#/components/schemas/SchedulingMethodDayOfMonth","day-of-week":"#/components/schemas/SchedulingMethodDayOfWeek","day-and-month-of-year":"#/components/schemas/SchedulingMethodDayAndMonthOfYear"}},"oneOf":[{"$ref":"#/components/schemas/SchedulingMethodDayOfMonth"},{"$ref":"#/components/schemas/SchedulingMethodDayOfWeek"},{"$ref":"#/components/schemas/SchedulingMethodDayAndMonthOfYear"}]}},"components/schemas/PlanTrial":{"id":"components/schemas/PlanTrial","kind":"json-schema","title":"PlanTrial","data":{"type":["object","null"],"required":["price","period"],"properties":{"price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price of setting up a trial."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If your service charges a fee for a trial, specify it here."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To charge no trial fee, set this value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number","format":"double"},"period":{"type":"object","description":"Period information.","required":["unit","length"],"properties":{"unit":{"description":"Unit of time.","type":"string","enum":["day","week","month","year"]},"length":{"description":"Length of time.","type":"integer","minimum":1}}}}}},"components/schemas/InvoiceTimeShift":{"id":"components/schemas/InvoiceTimeShift","kind":"json-schema","title":"InvoiceTimeShift","data":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use invoice time shift to control the billing time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice time shift adjusts the invoice issue and due date when billing must occur before the service period changes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use invoice time shift in conjunction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingTiming"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill immediately when the service period starts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill immediately after the service period ends."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill at an interval of time before the service period starts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill at an interval of time after the service period starts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill at an interval of time before the service period ends."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bill at an interval of time after the service period ends."},"children":[]}]}]}]}],"properties":{"issueTimeShift":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculation instruction of the billing time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is used in conjunction with the service period anchor to calculate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the time at which the invoice is issued. For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service period anchor, billing timing, and invoice time shift"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["chronology","duration","unit"],"properties":{"chronology":{"type":"string","description":"Sequential order of the billing time relative to the start of the service period.","enum":["before"]},"duration":{"type":"integer","description":"Amount of time by which to move the invoice issue time or date.","minimum":1},"unit":{"description":"Unit of time.","oneOf":[{"$ref":"#/components/schemas/TimeUnit"},{"$ref":"#/components/schemas/TimePluralUnit"}]}}},"dueTimeShift":{"type":"object","required":["duration","unit"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculation instruction of the invoice due time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is used in conjunction with the billing anchor to calculate when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an invoice is due for payment. For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service period anchor, billing timing, and invoice time shift"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sequential order of due time shift is always after the due date."},"children":[]}]}]}],"default":{"duration":1,"unit":"hour"},"properties":{"duration":{"type":"integer","description":"Amount of time by which to move the invoice due time or date.","minimum":1},"unit":{"description":"Unit of time.","oneOf":[{"$ref":"#/components/schemas/TimeUnit"},{"$ref":"#/components/schemas/TimePluralUnit"}]}}}}}},"components/schemas/SubscriptionPlan":{"id":"components/schemas/SubscriptionPlan","kind":"json-schema","title":"SubscriptionPlan","data":{"title":"SubscriptionPlan","description":"Details of the subscription order plan.\nUse this plan for subscriptions or sales that reoccur over a period of time.","type":"object","required":["name","currency","productId","pricing","recurringInterval"],"properties":{"name":{"description":"Name of the plan.\nThis name is displayed on invoices and receipts.","type":"string","maxLength":255},"description":{"type":"string","description":"Plain-text description of the plan.\nThis field accepts plain-text only.","maxLength":65535},"richDescription":{"type":"string","description":"Rich-text description of the plan.\nThis field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks.","maxLength":65535},"productId":{"type":"string","description":"ID of the related product.","maxLength":50,"example":"prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"},"productOptions":{"type":["object","null"],"description":"Name-value pairs that specify the product options.","additionalProperties":{"type":"string"},"example":{"color":"red","size":"xxl"}},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"currencySign":{"description":"Currency sign.","readOnly":true,"type":"string"},"pricing":{"$ref":"#/components/schemas/PlanPriceFormula"},"setup":{"$ref":"#/components/schemas/PlanSetup"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"isActive":{"type":"boolean","description":"Specifies if the plan is active.","default":true},"revision":{"type":"integer","readOnly":true,"description":"Number of times the plan is modified.\nCompare this value with materialized subscription item revision values."},"isTrialOnly":{"type":"boolean","const":false,"description":"Specifies if a plan is a trial that does not have recurring instructions.","readOnly":true},"recurringInterval":{"description":"Service interval settings.","type":"object","required":["unit","length"],"properties":{"periodAnchorInstruction":{"$ref":"#/components/schemas/ServicePeriodAnchorInstruction"},"unit":{"description":"Unit of time.","type":"string","enum":["day","week","month","year"]},"length":{"description":"Length of time.","type":"integer","minimum":1},"limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of invoices the subscription order generates."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only the initial order creation is generated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: For a 1 year contract that is billed monthly,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"where the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodDuration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set this field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["integer","null"],"minimum":1,"maximum":65535},"billingTiming":{"type":"string","default":"prepaid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing timing in relation to the service period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prepaid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plans the customer pays when the service period starts,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whereas, for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"postpaid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plans, the customer pays when the service period ends."},"children":[]}]}]}],"enum":["prepaid","postpaid"]}}},"trial":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trial configuration setting."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not want to offer a trial, set this value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/PlanTrial"},"meteredBilling":{"type":["object","null"],"required":["strategy"],"description":"Use metered billing when an exact quantity is unknown.\nReport usage during a service period and charge customers afterwards.\nMetered billing plans must be postpaid.","properties":{"strategy":{"type":"string","enum":["sum","last"],"x-enumDescriptions":{"sum":"Total amount of reported invoice item quantity usage.","last":"Last reported invoice item quantity usage."}},"min":{"description":"Minimum quantity that is charged at the end of a service period regardless of reported usage.","type":["number","null"],"format":"float","minimum":0.01},"max":{"description":"Maximum quantity that is charged at the end of a service period regardless of reported usage.","type":["number","null"],"format":"float","minimum":0.01},"sticky":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When enabled, if no usage is reported during a service period,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the plan bills the last known reported quantity from a previous period instead of zero."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is suitable for hosted or persistent resources whose usage does not change every period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only supported with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"strategy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false,"example":false}}},"invoiceTimeShift":{"readOnly":true,"deprecated":true,"$ref":"#/components/schemas/InvoiceTimeShift"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","attachments"]}}}}}}},"components/schemas/TrialOnlyPlan":{"id":"components/schemas/TrialOnlyPlan","kind":"json-schema","title":"TrialOnlyPlan","data":{"title":"TrialOnlyPlan","description":"Details of the trial-only plan.\nUse this plan for limited-time product trials.\nTrials may have a reduced fee, or may be free.","type":"object","required":["name","currency","productId","trial"],"properties":{"name":{"description":"Name of the plan.\nThis name is displayed on invoices and receipts.","type":"string","maxLength":255},"description":{"type":"string","description":"Plain-text description of the plan.\nThis field accepts plain-text only.","maxLength":65535},"richDescription":{"type":"string","description":"Rich-text description of the plan.\nThis field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks.","maxLength":65535},"productId":{"type":"string","description":"ID of the related product.","maxLength":50,"example":"prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"},"productOptions":{"type":["object","null"],"description":"Name-value pairs that specify the product options.","additionalProperties":{"type":"string"},"example":{"color":"red","size":"xxl"}},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"currencySign":{"description":"Currency sign.","readOnly":true,"type":"string"},"setup":{"$ref":"#/components/schemas/PlanSetup"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"isActive":{"type":"boolean","description":"Specifies if the plan is active.","default":true},"revision":{"type":"integer","readOnly":true,"description":"Number of times the plan is modified.\nCompare this value with materialized subscription item revision values."},"isTrialOnly":{"type":"boolean","const":true,"description":"Specifies if a plan is a trial that does not have recurring instructions.","readOnly":true},"recurringInterval":{"type":"null","description":"Service interval settings.","readOnly":true},"trial":{"description":"Trial configuration settings.","$ref":"#/components/schemas/PlanTrial"},"invoiceTimeShift":{"readOnly":true,"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use invoice time shift to adjust the invoice issue and due date when billing must occur before the service period changes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, rent must be paid in advance,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"so the invoice must be in advance of the billing date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service period anchor, and billing timing, and invoice time shift"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/InvoiceTimeShift"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","attachments"]}}}}}}},"components/schemas/Plan":{"id":"components/schemas/Plan","kind":"json-schema","title":"Plan","data":{"oneOf":[{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"ID of the plan.","maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X","readOnly":true}}},{"$ref":"#/components/schemas/OneTimeSalePlan"}]},{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"ID of the plan.","maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X","readOnly":true}}},{"$ref":"#/components/schemas/SubscriptionPlan"}]},{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"ID of the plan.","maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X","readOnly":true}}},{"$ref":"#/components/schemas/TrialOnlyPlan"}]}]}},"components/schemas/Product":{"id":"components/schemas/Product","kind":"json-schema","title":"Product","data":{"type":"object","required":["name"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Products are the items that your business sells."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Products include digital goods, services, and physical goods."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Products appear on invoice line items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set a tax category identifier, taxes are calculated at invoice generation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the product is shippable, shipping costs are calculated at invoice generation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricing and variations are set within plans."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/api/plans/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"ID of the product.","readOnly":true,"maxLength":50,"example":"prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"},"name":{"description":"Name of the product.","type":"string","minLength":3,"maxLength":255,"example":"Premium membership"},"unitLabel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit label, such as per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","minLength":1,"maxLength":50,"example":"seat","default":"unit"},"description":{"description":"Description of the product.","type":["string","null"],"maxLength":512},"requiresShipping":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the product requires shipping."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", shipping calculations are applied."},"children":[]}]}]}],"type":"boolean","example":false,"default":false},"options":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product options such as color, size, and so forth."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product option values are defined in plans."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/api/plans/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"string"}},"taxCategoryId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax category of the product."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a complete list of supported tax categories, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.taxjar.com/api/reference/#get-list-tax-categories"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TaxJar sales tax API reference"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If none of the tax categories from the list are applicable for your product, use the general tax category "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"00000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"example":"00000"},"accountingCode":{"description":"Accounting code of the product.","type":["string","null"],"example":"4010"},"recognition":{"type":["object","null"],"properties":{"debitAccountId":{"description":"ID of the debit journal account.","type":["string","null"]},"creditAccountId":{"description":"ID of the credit journal account.","type":["string","null"]}}},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/OriginalPlan":{"id":"components/schemas/OriginalPlan","kind":"json-schema","title":"OriginalPlan","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use an existing plan without changes for the current order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new plan, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/plans/postplan"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["id"],"additionalProperties":false,"properties":{"id":{"description":"ID of the plan.","$ref":"#/components/schemas/ResourceId"}}}},"components/schemas/FlexiblePlan":{"id":"components/schemas/FlexiblePlan","kind":"json-schema","title":"FlexiblePlan","data":{"oneOf":[{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"ID of the plan.","maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"}}},{"$ref":"#/components/schemas/OneTimeSalePlan"}]},{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"ID of the plan.","maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"}}},{"$ref":"#/components/schemas/SubscriptionPlan"}]},{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"ID of the plan.","maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"}}},{"$ref":"#/components/schemas/TrialOnlyPlan"}]}]}},"components/schemas/UsageLimits":{"id":"components/schemas/UsageLimits","kind":"json-schema","title":"UsageLimits","data":{"type":"object","description":"Specifies the soft and hard usage limit thresholds for an item with a metered billing plan.\nThis value is ignored when the plan is not metered.","properties":{"softLimit":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines thresholds for notification purposes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, to notify the customer that their usage is near the hard limit of their metered billing plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This notification informs the customer so that they can upgrade their plan before the hard limit is reached."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the reported usage reaches 75%, 90%, and 100% of the configured limit a specific event is triggered."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To notify the customer, a webhook and notification can be configured for this event."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is useful for accounting and customer success purposes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The usage of metered billing plans can still be reported if the soft limit is reached."},"children":[]}]}]}],"minProperties":1,"maxProperties":1,"properties":{"quantity":{"type":"integer","description":"Usage limit quantity.","minimum":0},"amount":{"type":"number","format":"double","description":"Usage limit amount in the currency of the order.","minimum":0}}},"hardLimit":{"type":"object","description":"Defines a limit where the customer can no longer use the service.\nHard limits are used in addition to soft limits.\nWhen a soft limit is reached,\na customer may receive a notification\nbut the service can still be provided up to the hard limit value so that the customer can upgrade their plan.\nWhen the reported usage reaches the configured limit,\na specific event is triggered.\nTo notify the customer in the merchant system,\nor block a service,\na webhook and notification can be configured for this event.\nWhen the total usage reaches the hard limit quantity,\nor amount values,\nmetered billing plan usages can no longer be reported.","minProperties":1,"maxProperties":1,"properties":{"quantity":{"type":"integer","description":"Usage limit quantity.","minimum":0},"amount":{"type":"number","format":"double","description":"Usage limit amount in the currency of the order.","minimum":0}}},"trialLimit":{"oneOf":[{"type":"number","format":"double","minimum":0},{"type":"null"}],"description":"Defines a usage cap during the trial period of a subscription.\nThis limit is enforced only while the subscription is in its trial phase.\nWhen the reported usage reaches the configured trial limit, an event called 'trial-usage-limit-reached' is triggered.\nTo notify the customer or restrict access to the service, a webhook and notification can be configured for this event.\nOnce the trial limit is reached, additional usage cannot be reported unless the trial ends.","example":20.725}}}},"components/schemas/QuoteSubscriptionItem":{"id":"components/schemas/QuoteSubscriptionItem","kind":"json-schema","title":"QuoteSubscriptionItem","data":{"type":"object","required":["plan","type"],"properties":{"id":{"description":"ID of the quote item.","readOnly":true,"type":"string","example":"qt_itm_01HXCEQNR3F1G2A6RX6HPS3KFY"},"type":{"description":"Specifies the type of order item.","type":"string","x-basic":true,"enum":["subscription"]},"quantity":{"description":"Number of product units in the specified plan.\nQuantity for metered billing is always 0.","type":"integer","default":1,"minimum":0,"maximum":1000000000},"quantityFilled":{"description":"Number of filled product units.\nThis field is not used for metered billing plans.","type":["number","null"],"format":"double","example":5.125},"plan":{"description":"Plan details.","oneOf":[{"$ref":"#/components/schemas/OriginalPlan"},{"$ref":"#/components/schemas/FlexiblePlan"}]},"description":{"type":"string","description":"Description of the quote item.","example":"Charge per approved transaction with DCC","default":"","maxLength":255},"priceDescription":{"type":"string","description":"Price description of the quote item.\nThis value is only used for metered billing items.","example":"50% of the markup for approved transactions","default":"","maxLength":255},"usageLimits":{"oneOf":[{"$ref":"#/components/schemas/UsageLimits"},{"type":"null"}],"default":null},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"}}}},"components/schemas/QuoteOneTimeSaleItem":{"id":"components/schemas/QuoteOneTimeSaleItem","kind":"json-schema","title":"QuoteOneTimeSaleItem","data":{"type":"object","required":["plan","type"],"properties":{"id":{"description":"ID of the quote item.","readOnly":true,"type":"string","example":"qt_itm_01HXCEQNR3F1G2A6RX6HPS3KFY"},"type":{"description":"Specifies the type of order item.","type":"string","x-basic":true,"enum":["one-time-sale"]},"quantity":{"description":"Number of product units in the specified plan.","type":"integer","default":1,"minimum":0,"maximum":1000000000},"plan":{"description":"Plan details.","oneOf":[{"$ref":"#/components/schemas/OriginalPlan"},{"$ref":"#/components/schemas/FlexiblePlan"}]},"description":{"type":"string","description":"Description of the quote item.","example":"Charge per approved transaction with DCC","default":"","maxLength":255},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"}}}},"components/schemas/QuoteItem":{"id":"components/schemas/QuoteItem","kind":"json-schema","title":"QuoteItem","data":{"type":"object","discriminator":{"propertyName":"type","mapping":{"subscription":"#/components/schemas/QuoteSubscriptionItem","one-time-sale":"#/components/schemas/QuoteOneTimeSaleItem"}},"oneOf":[{"$ref":"#/components/schemas/QuoteSubscriptionItem"},{"$ref":"#/components/schemas/QuoteOneTimeSaleItem"}]}},"components/schemas/CreationQuote":{"id":"components/schemas/CreationQuote","kind":"json-schema","title":"CreationQuote","data":{"type":"object","title":"CreationQuote","required":["websiteId","customerId","order","type"],"properties":{"id":{"readOnly":true,"description":"ID of the quote.","type":"string","maxLength":50,"example":"qt_01HXBZMEGPETPHJZH6V4RHBMA8"},"type":{"description":"Type of the quote.\nWhen a quote is accepted, a new order is created.","type":"string","enum":["creation"]},"acceptanceConditions":{"type":"array","writeOnly":true,"description":"Conditions that must be met for the quote to be automatically accepted.","items":{"type":"string","enum":["customer","payment"],"x-enumDescriptions":{"customer":"Quote can be accepted by customer.","payment":"Related invoice must be paid in full."}},"example":["payment"],"default":["customer"]},"acceptanceFulfillment":{"type":"array","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"acceptanceConditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with fulfillment status."},"children":[]}]}]}],"items":{"type":"object","properties":{"condition":{"type":"string","enum":["customer","payment","organization"]},"isFulfilled":{"type":"boolean"}}}},"isNewOrder":{"description":"Specifies if the order is a new order.","type":"boolean","readOnly":true,"example":true},"invoiceId":{"type":"string","description":"ID of the payment invoice.","readOnly":true,"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"status":{"description":"Status of the quote.","type":"string","readOnly":true,"enum":["draft","issued","accepted","rejected","canceled","expired"],"x-enumDescriptions":{"draft":"Quote can be edited. This quote cannot be sent to a customer.","issued":"Quote cannot be edited. This quote can be sent to a customer.","accepted":"Customer accepted the quote and created an order.","rejected":"Customer rejected the quote.","canceled":"Organization or customer canceled the quote.","expired":"Expired before customer or organization interaction."}},"websiteId":{"$ref":"#/components/schemas/WebsiteId"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"order":{"type":"object","description":"Properties of the related order.","required":["items"],"properties":{"id":{"description":"ID of the related order.","readOnly":true,"type":["string","null"],"maxLength":50,"example":"ord_01HVKA5975PJBSQ1SX72G3MSZC"},"items":{"type":"array","description":"Items included in the quote.","minItems":1,"items":{"$ref":"#/components/schemas/QuoteItem"}},"autopay":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if payment attempts for the related order are made automatically."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrumentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or the default payment instrument on the order."},"children":[]}]}]}]},"shipping":{"$ref":"#/components/schemas/Shipping"},"deliveryAddress":{"description":"Delivery address of the order.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"billingAddress":{"description":"Billing address of the order.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"startTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the created order starts."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the quote acceptance time is used."},"children":[]}]}]}],"type":["string","null"],"x-sortable":true,"x-basic":true,"format":"date-time"},"isLegacy":{"description":"Specifies if the order is a legacy order.","type":"boolean","default":true,"example":true}}},"invoicePreview":{"type":"object","description":"Preview of the quote invoice.","readOnly":true,"properties":{"currency":{"description":"Currency of the invoice.","$ref":"#/components/schemas/CurrencyCode"},"initialAmounts":{"type":"object","description":"Total amounts of the initial invoice.","properties":{"amount":{"description":"Amount of the invoice.","type":"number","x-type":"Money","format":"double"},"subtotalAmount":{"description":"Subtotal amount of the invoice.","type":"number","x-type":"Money","format":"double"},"discountAmount":{"description":"Discount amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"},"shippingAmount":{"description":"Shipping amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"},"taxAmount":{"description":"Tax amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"}}},"recurringAmounts":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total amounts of the recurring invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes recurring items only."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the quote does not have recurring items, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"amount":{"description":"Amount of the invoice.","type":"number","x-type":"Money","format":"double"},"subtotalAmount":{"description":"Subtotal amount of the invoice.","type":"number","x-type":"Money","format":"double"},"discountAmount":{"description":"Discount amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"},"shippingAmount":{"description":"Shipping amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"},"taxAmount":{"description":"Tax amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"}}},"items":{"type":"array","description":"Invoice items.","items":{"type":"object","properties":{"quoteItemId":{"description":"ID of the related quote item.","type":"string","example":"qt_itm_01HXCEQNR3F1G2A6RX6HPS3KFY"},"type":{"type":"string","description":"Type of the invoice item.","x-basic":true,"enum":["debit","credit"]},"name":{"description":"Name of the invoice item.","type":"string","maxLength":1000},"description":{"description":"Description of the invoice item.","type":"string","example":"Charge per approved transaction with DCC","maxLength":255},"priceDescription":{"type":"string","description":"Price description of the invoice item.","example":"50% of the markup for approved transactions","maxLength":255},"unitPrice":{"description":"Unit price of the invoice item.","type":["number","null"],"format":"double"},"quantity":{"description":"Quantity of the invoice item.","type":"integer"},"period":{"description":"Date interval of the invoice item.","type":["string","null"]},"setupUnitPrice":{"description":"Unit price of the invoice item.","type":["number","null"],"format":"double"},"trialUnitPrice":{"description":"Unit price of the invoice item.","type":["number","null"],"format":"double"},"trialPeriod":{"description":"Date interval of the invoice item trial.","type":["string","null"]},"taxAmount":{"description":"Tax amount of the invoice item.","type":["number","null"],"format":"double"},"setupTaxAmount":{"description":"Tax amount of the setup that is applied to the invoice.","type":["number","null"],"format":"double"},"trialTaxAmount":{"description":"Tax amount of the trial that is applied to the invoice.","type":["number","null"],"format":"double"}}}}}},"paymentTerms":{"description":"Payment terms for the customer which are displayed on the quote.","type":"string"},"expirationTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the quote expires."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default expiration time is one month from the time the quote is issued."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, this field may be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"format":"date-time"},"issuedTime":{"description":"Date and time when the quote is issued.","type":["string","null"],"readOnly":true,"format":"date-time"},"acceptedTime":{"description":"Date and time when the quote is accepted.","type":["string","null"],"readOnly":true,"format":"date-time"},"rejectedTime":{"description":"Date and time when the quote is rejected.","type":["string","null"],"readOnly":true,"format":"date-time"},"canceledTime":{"description":"Date and time when the quote is canceled.","type":["string","null"],"readOnly":true,"format":"date-time"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"redirectUrl":{"description":"URL to redirect the customer to when a quote is rejected.\nThe default value is the website URL.","type":"string","maxLength":2083,"format":"uri"},"signature":{"type":"object","description":"Written signature and printed organization name.","properties":{"showWrittenSignatureLines":{"type":"boolean","default":false,"description":"Specifies whether to show written signature lines."},"organizationPrintedName":{"type":["string","null"],"description":"Printed name of the organization.","default":null}}},"tax":{"$ref":"#/components/schemas/Taxes"},"couponIds":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of coupons to redeem on the customer and apply to the related invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/coupons-and-discounts/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coupons"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","description":"Coupon ID."}},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of link."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the quote is issued, a customer can be redirected to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicePaymentFormUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to pay the related invoice using one of the methods which are available to the customer."},"children":[]}]}]}],"type":"string","enum":["self","quoteAcceptanceFormUrl","invoicePaymentFormUrl"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"type":"object"},"website":{"type":"object"},"order":{"type":"object"},"invoice":{"type":"object"}}}}}},"components/schemas/ChangeQuote":{"id":"components/schemas/ChangeQuote","kind":"json-schema","title":"ChangeQuote","data":{"type":"object","title":"ChangeQuote","required":["websiteId","customerId","order","type"],"properties":{"id":{"readOnly":true,"description":"ID of the quote.","type":"string","maxLength":50,"example":"qt_01HXBZMEGPETPHJZH6V4RHBMA8"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the quote."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a quote is accepted, quote items and settings are applied to the related order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change quotes can only be created for orders with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trial-ended"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trial-ended"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" orders, use this quote type to convert a trial-only order to a regular recurring order."},"children":[]}]}]}],"type":"string","enum":["change"]},"acceptanceConditions":{"type":"array","writeOnly":true,"description":"Conditions that must be met for the quote to be automatically accepted.","items":{"type":"string","enum":["customer","payment"],"x-enumDescriptions":{"customer":"Quote can be accepted by customer.","payment":"Related invoice must be paid in full."}},"example":["payment"],"default":["customer"]},"acceptanceFulfillment":{"type":"array","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"acceptanceConditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with fulfillment status."},"children":[]}]}]}],"items":{"type":"object","properties":{"condition":{"type":"string","enum":["customer","payment","organization"]},"isFulfilled":{"type":"boolean"}}}},"isNewOrder":{"description":"Specifies if the order is a new order.","type":"boolean","readOnly":true,"example":true},"invoiceId":{"type":"string","description":"ID of the payment invoice.","readOnly":true,"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"status":{"description":"Status of the quote.","type":"string","readOnly":true,"enum":["draft","issued","accepted","rejected","canceled","expired"],"x-enumDescriptions":{"draft":"Quote can be edited. This quote cannot be sent to a customer.","issued":"Quote cannot be edited. This quote can be sent to a customer.","accepted":"Customer accepted the quote. Quote items and settings are applied to the order.","rejected":"Customer rejected the quote.","canceled":"Organization or customer canceled the quote.","expired":"Expired before customer or organization interaction."}},"websiteId":{"$ref":"#/components/schemas/WebsiteId"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"order":{"type":"object","description":"Properties of the related order.","required":["id","items"],"properties":{"id":{"description":"ID of the related order.","type":"string","maxLength":50,"example":"ord_01HVKA5975PJBSQ1SX72G3MSZC"},"items":{"type":"array","description":"Items included in the quote.","minItems":1,"items":{"$ref":"#/components/schemas/QuoteItem"}},"renewalPolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Policy for managing service periods and trial state of the related order when the quote is accepted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values are deprecated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deprecated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keepTrial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag is ignored unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used, or this field is omitted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is omitted, this value defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is omitted and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keepTrial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialThenRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","default":"retainRecurring","enum":["resetToRecurring","retainRecurring","retainTrialThenRecurring","reset","retain"],"x-enumDescriptions":{"resetToRecurring":"Resets the service periods, ends any trial, and converts trial-only items to recurring.","retainRecurring":"Retains the current service periods, ends any trial, and converts trial-only items to recurring.","retainTrialThenRecurring":"Retains the trial until it ends, then converts the item to recurring.\nReturns a validation error if the order has no trial.","reset":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resetToRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resets the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to a newly calculated value."},"children":[]}]}]}],"retain":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialThenRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retains the current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"prorated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to give a pro rata credit for the amount of time remaining between the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the end of the current period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In addition, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is retained, by setting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialThenRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a pro rata debit occurs for the amount between the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a percentage of the normal period length."},"children":[]}]}]}],"type":"boolean"},"effectiveTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date from which the renewal time for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations and proration calculations are made."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is omitted, this value defaults to the time of quote acceptance."},"children":[]}]}]}],"type":["string","null"],"format":"date-time"},"keepTrial":{"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialThenRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the order must retain its active trial."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to the deprecated value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or omitted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted and this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialThenRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"interimOnly":{"type":"boolean","default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the quotation invoice must include interim items only."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all upcoming items are included."},"children":[]}]}]}]},"usageSettings":{"type":"array","default":[],"description":"Usage settings for items with metered billing.","items":{"type":"object","required":["productId","policy"],"properties":{"productId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the product to use to transfer usage."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"policy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and an existing item and a new item are of the same product,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usage can be transferred to the new item."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a new item of the same product does not exist,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or does not have a metered billing plan,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this transfer is ignored."},"children":[]}]}]}],"example":"prod_0YV7DENSVGDBW9S71XZNNYYQ0X"},"policy":{"type":"string","enum":["reset","transfer"],"description":"Policy for removed items that have a metered billing plan.","x-enumDescriptions":{"reset":"Delete existing usages.","transfer":"Transfer usages from removed item to new item of the same product."}}}}},"autopay":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if payment attempts for the related order are made automatically."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrumentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or the default payment instrument on the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the related order autopay is not affected."},"children":[]}]}]}]},"shipping":{"description":"Shipping settings of the order.\nIf this value is omitted, the order shipping is not affected.","allOf":[{"$ref":"#/components/schemas/Shipping"}]},"deliveryAddress":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery address of the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the order delivery address is not affected."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"billingAddress":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing address of the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the order billing address is not affected."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]}}},"invoicePreview":{"type":"object","description":"Preview of the quote invoice.","readOnly":true,"properties":{"currency":{"description":"Currency of the invoice.","$ref":"#/components/schemas/CurrencyCode"},"initialAmounts":{"type":"object","description":"Total amounts of the initial invoice.","properties":{"amount":{"description":"Amount of the invoice.","type":"number","x-type":"Money","format":"double"},"subtotalAmount":{"description":"Subtotal amount of the invoice.","type":"number","x-type":"Money","format":"double"},"discountAmount":{"description":"Discount amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"},"shippingAmount":{"description":"Shipping amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"},"taxAmount":{"description":"Tax amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"}}},"recurringAmounts":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total amounts of the recurring invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes recurring items only."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the quote does not have recurring items, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"amount":{"description":"Amount of the invoice.","type":"number","x-type":"Money","format":"double"},"subtotalAmount":{"description":"Subtotal amount of the invoice.","type":"number","x-type":"Money","format":"double"},"discountAmount":{"description":"Discount amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"},"shippingAmount":{"description":"Shipping amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"},"taxAmount":{"description":"Tax amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"}}},"items":{"type":"array","description":"Invoice items.","items":{"type":"object","properties":{"quoteItemId":{"description":"ID of the related quote item.","type":"string","example":"qt_itm_01HXCEQNR3F1G2A6RX6HPS3KFY"},"type":{"type":"string","description":"Type of the invoice item.","x-basic":true,"enum":["debit","credit"]},"name":{"description":"Name of the invoice item.","type":"string","maxLength":1000},"description":{"description":"Description of the invoice item.","type":"string","example":"Charge per approved transaction with DCC","maxLength":255},"priceDescription":{"type":"string","description":"Price description of the invoice item.","example":"50% of the markup for approved transactions","maxLength":255},"unitPrice":{"description":"Unit price of the invoice item.","type":["number","null"],"format":"double"},"quantity":{"description":"Quantity of the invoice item.","type":"integer"},"period":{"description":"Date interval of the invoice item.","type":["string","null"]},"setupUnitPrice":{"description":"Unit price of the invoice item.","type":["number","null"],"format":"double"},"trialUnitPrice":{"description":"Unit price of the invoice item.","type":["number","null"],"format":"double"},"trialPeriod":{"description":"Date interval of the invoice item trial.","type":["string","null"]},"taxAmount":{"description":"Tax amount of the invoice item.","type":["number","null"],"format":"double"},"setupTaxAmount":{"description":"Tax amount of the setup that is applied to the invoice.","type":["number","null"],"format":"double"},"trialTaxAmount":{"description":"Tax amount of the trial that is applied to the invoice.","type":["number","null"],"format":"double"}}}}}},"paymentTerms":{"description":"Payment terms for the customer which are displayed on the quote.","type":"string"},"expirationTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the quote expires."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default expiration time is one month from the time the quote is issued."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, this field may be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"format":"date-time"},"issuedTime":{"description":"Date and time when the quote is issued.","type":["string","null"],"readOnly":true,"format":"date-time"},"acceptedTime":{"description":"Date and time when the quote is accepted.","type":["string","null"],"readOnly":true,"format":"date-time"},"rejectedTime":{"description":"Date and time when the quote is rejected.","type":["string","null"],"readOnly":true,"format":"date-time"},"canceledTime":{"description":"Date and time when the quote is canceled.","type":["string","null"],"readOnly":true,"format":"date-time"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"redirectUrl":{"description":"URL to redirect the customer to when a quote is rejected.\nThe default value is the website URL.","type":"string","maxLength":2083,"format":"uri"},"signature":{"type":"object","description":"Written signature and printed organization name.","properties":{"showWrittenSignatureLines":{"type":"boolean","default":false,"description":"Specifies whether to show written signature lines."},"organizationPrintedName":{"type":["string","null"],"description":"Printed name of the organization.","default":null}}},"tax":{"$ref":"#/components/schemas/Taxes"},"couponIds":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of coupons to redeem on the customer and apply to the related invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/coupons-and-discounts/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coupons"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","description":"Coupon ID."}},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of link."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the quote is issued, a customer can be redirected to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicePaymentFormUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to pay the related invoice using one of the methods which are available to the customer."},"children":[]}]}]}],"type":"string","enum":["self","quoteAcceptanceFormUrl","invoicePaymentFormUrl"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"type":"object"},"website":{"type":"object"},"order":{"type":"object"},"invoice":{"type":"object"}}}}}},"components/schemas/ReactivationQuote":{"id":"components/schemas/ReactivationQuote","kind":"json-schema","title":"ReactivationQuote","data":{"type":"object","title":"ReactivationQuote","required":["websiteId","customerId","order","type"],"properties":{"id":{"readOnly":true,"description":"ID of the quote.","type":"string","maxLength":50,"example":"qt_01HXBZMEGPETPHJZH6V4RHBMA8"},"type":{"description":"Type of the quote.\nWhen a quote is accepted, quote items and settings are applied to the order and the order is reactivated.","type":"string","enum":["reactivation"]},"acceptanceConditions":{"type":"array","writeOnly":true,"description":"Conditions that must be met for the quote to be automatically accepted.","items":{"type":"string","enum":["customer","payment"],"x-enumDescriptions":{"customer":"Quote can be accepted by customer.","payment":"Related invoice must be paid in full."}},"example":["payment"],"default":["customer"]},"acceptanceFulfillment":{"type":"array","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"acceptanceConditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with fulfillment status."},"children":[]}]}]}],"items":{"type":"object","properties":{"condition":{"type":"string","enum":["customer","payment","organization"]},"isFulfilled":{"type":"boolean"}}}},"isNewOrder":{"description":"Specifies if the order is a new order.","type":"boolean","readOnly":true,"example":true},"invoiceId":{"type":"string","description":"ID of the payment invoice.","readOnly":true,"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"status":{"description":"Status of the quote.","type":"string","readOnly":true,"enum":["draft","issued","accepted","rejected","canceled","expired"],"x-enumDescriptions":{"draft":"Quote can be edited. This quote cannot be sent to a customer.","issued":"Quote cannot be edited. This quote can be sent to a customer.","accepted":"Customer accepted the quote. The related order is reactivated and quote items and settings are applied to the order.","rejected":"Customer rejected the quote.","canceled":"Organization or customer canceled the quote.","expired":"Expired before customer or organization interaction."}},"websiteId":{"$ref":"#/components/schemas/WebsiteId"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"order":{"type":"object","description":"Properties of the related order.","required":["id","items"],"properties":{"id":{"description":"ID of the related order.","type":"string","maxLength":50,"example":"ord_01HVKA5975PJBSQ1SX72G3MSZC"},"items":{"type":"array","description":"Items included in the quote.","minItems":1,"items":{"$ref":"#/components/schemas/QuoteItem"}},"effectiveTime":{"description":"Date and time when the service period starts,\nunless the order is canceled but still active.\nIf the order is still active,\nthe order continues for the current service period.\n\nIf this field is omitted, this value defaults to the current time.","type":["string","null"],"format":"date-time"},"renewalTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time of the next order renewal."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is omitted, this value is computed from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the order is canceled but still active,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it is ignored and the next renewal occurs as scheduled."},"children":[]}]}]}],"type":["string","null"],"format":"date-time"},"paymentInstrumentId":{"description":"ID of the payment instrument.\nIf this field is omitted, the order payment instrument remains unchanged.","type":["string","null"],"maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"},"autopay":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if payment attempts for the related order are made automatically."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrumentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or the default payment instrument on the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the related order autopay is not affected."},"children":[]}]}]}]},"shipping":{"description":"Shipping settings of the order.\nIf this value is omitted, the order shipping is not affected.","allOf":[{"$ref":"#/components/schemas/Shipping"}]},"deliveryAddress":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery address of the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the order delivery address is not affected."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"billingAddress":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing address of the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the order billing address is not affected."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]}}},"invoicePreview":{"type":"object","description":"Preview of the quote invoice.","readOnly":true,"properties":{"currency":{"description":"Currency of the invoice.","$ref":"#/components/schemas/CurrencyCode"},"initialAmounts":{"type":"object","description":"Total amounts of the initial invoice.","properties":{"amount":{"description":"Amount of the invoice.","type":"number","x-type":"Money","format":"double"},"subtotalAmount":{"description":"Subtotal amount of the invoice.","type":"number","x-type":"Money","format":"double"},"discountAmount":{"description":"Discount amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"},"shippingAmount":{"description":"Shipping amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"},"taxAmount":{"description":"Tax amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"}}},"recurringAmounts":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total amounts of the recurring invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes recurring items only."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the quote does not have recurring items, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"amount":{"description":"Amount of the invoice.","type":"number","x-type":"Money","format":"double"},"subtotalAmount":{"description":"Subtotal amount of the invoice.","type":"number","x-type":"Money","format":"double"},"discountAmount":{"description":"Discount amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"},"shippingAmount":{"description":"Shipping amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"},"taxAmount":{"description":"Tax amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double"}}},"items":{"type":"array","description":"Invoice items.","items":{"type":"object","properties":{"quoteItemId":{"description":"ID of the related quote item.","type":"string","example":"qt_itm_01HXCEQNR3F1G2A6RX6HPS3KFY"},"type":{"type":"string","description":"Type of the invoice item.","x-basic":true,"enum":["debit","credit"]},"name":{"description":"Name of the invoice item.","type":"string","maxLength":1000},"description":{"description":"Description of the invoice item.","type":"string","example":"Charge per approved transaction with DCC","maxLength":255},"priceDescription":{"type":"string","description":"Price description of the invoice item.","example":"50% of the markup for approved transactions","maxLength":255},"unitPrice":{"description":"Unit price of the invoice item.","type":["number","null"],"format":"double"},"quantity":{"description":"Quantity of the invoice item.","type":"integer"},"period":{"description":"Date interval of the invoice item.","type":["string","null"]},"setupUnitPrice":{"description":"Unit price of the invoice item.","type":["number","null"],"format":"double"},"trialUnitPrice":{"description":"Unit price of the invoice item.","type":["number","null"],"format":"double"},"trialPeriod":{"description":"Date interval of the invoice item trial.","type":["string","null"]},"taxAmount":{"description":"Tax amount of the invoice item.","type":["number","null"],"format":"double"},"setupTaxAmount":{"description":"Tax amount of the setup that is applied to the invoice.","type":["number","null"],"format":"double"},"trialTaxAmount":{"description":"Tax amount of the trial that is applied to the invoice.","type":["number","null"],"format":"double"}}}}}},"paymentTerms":{"description":"Payment terms for the customer which are displayed on the quote.","type":"string"},"expirationTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the quote expires."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default expiration time is one month from the time the quote is issued."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, this field may be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"format":"date-time"},"issuedTime":{"description":"Date and time when the quote is issued.","type":["string","null"],"readOnly":true,"format":"date-time"},"acceptedTime":{"description":"Date and time when the quote is accepted.","type":["string","null"],"readOnly":true,"format":"date-time"},"rejectedTime":{"description":"Date and time when the quote is rejected.","type":["string","null"],"readOnly":true,"format":"date-time"},"canceledTime":{"description":"Date and time when the quote is canceled.","type":["string","null"],"readOnly":true,"format":"date-time"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"redirectUrl":{"description":"URL to redirect the customer to when a quote is rejected.\nThe default value is the website URL.","type":"string","maxLength":2083,"format":"uri"},"signature":{"type":"object","description":"Written signature and printed organization name.","properties":{"showWrittenSignatureLines":{"type":"boolean","default":false,"description":"Specifies whether to show written signature lines."},"organizationPrintedName":{"type":["string","null"],"description":"Printed name of the organization.","default":null}}},"tax":{"$ref":"#/components/schemas/Taxes"},"couponIds":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of coupons to redeem on the customer and apply to the related invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/coupons-and-discounts/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coupons"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","description":"Coupon ID."}},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of link."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the quote is issued, a customer can be redirected to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicePaymentFormUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to pay the related invoice using one of the methods which are available to the customer."},"children":[]}]}]}],"type":"string","enum":["self","quoteAcceptanceFormUrl","invoicePaymentFormUrl"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"type":"object"},"website":{"type":"object"},"order":{"type":"object"},"invoice":{"type":"object"}}}}}},"components/schemas/Quote":{"id":"components/schemas/Quote","kind":"json-schema","title":"Quote","data":{"discriminator":{"propertyName":"type","mapping":{"creation":"#/components/schemas/CreationQuote","change":"#/components/schemas/ChangeQuote","reactivation":"#/components/schemas/ReactivationQuote"}},"oneOf":[{"$ref":"#/components/schemas/CreationQuote"},{"$ref":"#/components/schemas/ChangeQuote"},{"$ref":"#/components/schemas/ReactivationQuote"}]}},"components/schemas/PatchQuote":{"id":"components/schemas/PatchQuote","kind":"json-schema","title":"PatchQuote","data":{"type":"object","description":"Patch quote object.","properties":{"tax":{"$ref":"#/components/schemas/Taxes"}}}},"components/schemas/QuoteTimeline":{"id":"components/schemas/QuoteTimeline","kind":"json-schema","title":"QuoteTimeline","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the timeline message.","readOnly":true,"maxLength":50,"example":"tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC"},"type":{"description":"Type of timeline message.","type":"string","readOnly":true,"enum":["quote-created","quote-issued","quote-accepted","quote-rejected","quote-canceled","quote-recalled","quote-updated","quote-expired","quote-order-attached"]},"triggeredBy":{"description":"Specifies who, or what, triggered the timeline message.","type":"string","readOnly":true,"enum":["rebilly","app","direct-api"]},"message":{"description":"Contents of the timeline message.","type":"string"},"extraData":{"$ref":"#/components/schemas/TimelineExtraData"},"occurredTime":{"description":"Date and time when the timeline message occurred.","readOnly":true,"$ref":"#/components/schemas/ServerTimestamp"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/ReadyToPayAmount":{"id":"components/schemas/ReadyToPayAmount","kind":"json-schema","title":"With amount","data":{"type":"object","title":"With amount","required":["websiteId","currency","amount","riskMetadata"],"properties":{"websiteId":{"$ref":"#/components/schemas/WebsiteId"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"description":"Amount to pay.","type":"number","format":"double"},"billingAddress":{"description":"Billing address.","writeOnly":true,"$ref":"#/components/schemas/ContactObject"},"riskMetadata":{"$ref":"#/components/schemas/RiskMetadata"}}}},"components/schemas/ReadyToPayItems":{"id":"components/schemas/ReadyToPayItems","kind":"json-schema","title":"With items","data":{"type":"object","title":"With items","required":["websiteId","items","riskMetadata"],"properties":{"websiteId":{"$ref":"#/components/schemas/WebsiteId"},"items":{"type":"array","minItems":1,"items":{"type":"object","required":["planId","quantity"],"properties":{"planId":{"type":"string","description":"ID of the plan.","maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"},"quantity":{"description":"Number of product units in the specified plan.","type":"integer"}}}},"billingAddress":{"description":"Billing address.","writeOnly":true,"$ref":"#/components/schemas/ContactObject"},"riskMetadata":{"$ref":"#/components/schemas/RiskMetadata"}}}},"components/schemas/ReadyToPay":{"id":"components/schemas/ReadyToPay","kind":"json-schema","title":"ReadyToPay","data":{"type":"object","oneOf":[{"$ref":"#/components/schemas/ReadyToPayAmount"},{"$ref":"#/components/schemas/ReadyToPayItems"}]}},"components/schemas/PostReadyToPay":{"id":"components/schemas/PostReadyToPay","kind":"json-schema","title":"PostReadyToPay","data":{"allOf":[{"type":"object","properties":{"customerId":{"$ref":"#/components/schemas/CustomerId"}}},{"$ref":"#/components/schemas/ReadyToPay"}]}},"components/schemas/Country":{"id":"components/schemas/Country","kind":"json-schema","title":"Country","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 country code."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For examples, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/obp/ui/#search/code/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO.org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{2}$","example":"US"}},"components/schemas/DigitalWalletCountry":{"id":"components/schemas/DigitalWalletCountry","kind":"json-schema","title":"DigitalWalletCountry","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166 alpha-2 country code."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For examples, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/obp/ui/#search/code/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO.org"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{2}$","example":"US"}},"components/schemas/ApplePayFeature":{"id":"components/schemas/ApplePayFeature","kind":"json-schema","title":"Apple Pay Digital Wallet","data":{"type":"object","title":"Apple Pay Digital Wallet","properties":{"name":{"type":"string","description":"Name of the feature.","enum":["Apple Pay"]},"displayName":{"description":"String of 64 or fewer UTF-8 characters containing the canonical name for your store,\nthat is suitable for display.\nDo not localize the name.","type":"string","example":"Test Merchant"},"country":{"$ref":"#/components/schemas/DigitalWalletCountry"}}}},"components/schemas/GooglePayFeature":{"id":"components/schemas/GooglePayFeature","kind":"json-schema","title":"Google Pay Digital Wallet","data":{"type":"object","title":"Google Pay Digital Wallet","properties":{"name":{"type":"string","description":"Name of the feature.","enum":["Google Pay"]},"merchantName":{"description":"Merchant name in Google Pay.","type":"string","example":"Test Merchant"},"merchantOrigin":{"description":"Merchant origin in Google Pay.\nThe fully qualified domain name.","type":"string","example":"www.example.com"},"country":{"$ref":"#/components/schemas/DigitalWalletCountry"}}}},"components/schemas/SamsungPayFeature":{"id":"components/schemas/SamsungPayFeature","kind":"json-schema","title":"Samsung Pay Digital Wallet","data":{"type":"object","title":"Samsung Pay Digital Wallet","properties":{"name":{"type":"string","description":"Name of the feature.","enum":["Samsung Pay"]},"merchantName":{"description":"Merchant name in Samsung Pay.","type":"string","example":"Test Merchant"}}}},"components/schemas/PaymentCardFeature":{"id":"components/schemas/PaymentCardFeature","kind":"json-schema","title":"PaymentCardFeature","data":{"type":"object","discriminator":{"propertyName":"name","mapping":{"Apple Pay":"#/components/schemas/ApplePayFeature","Google Pay":"#/components/schemas/GooglePayFeature","Samsung Pay":"#/components/schemas/SamsungPayFeature"}},"oneOf":[{"$ref":"#/components/schemas/ApplePayFeature"},{"$ref":"#/components/schemas/GooglePayFeature"},{"$ref":"#/components/schemas/SamsungPayFeature"}]}},"components/schemas/ReadyToPayMethodFilters":{"id":"components/schemas/ReadyToPayMethodFilters","kind":"json-schema","title":"ReadyToPayMethodFilters","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the method to be applicable, one or more of the following filters must match."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no filters are sent, no restrictions are applied."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/search-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string"}}},"components/schemas/ReadyToPayPaymentCardMethod":{"id":"components/schemas/ReadyToPayPaymentCardMethod","kind":"json-schema","title":"Payment card","data":{"type":"object","title":"Payment card","required":["method"],"properties":{"method":{"type":"string","description":"Payment method.","enum":["payment-card"]},"feature":{"description":"Specific feature of this method.\nFor example, a digital wallet.\nIf the method does not have any features, this value is null.","oneOf":[{"$ref":"#/components/schemas/PaymentCardFeature"},{"type":"null"}]},"brands":{"type":"array","description":"List of supported brands.","minItems":1,"items":{"$ref":"#/components/schemas/PaymentCardBrand"}},"filters":{"$ref":"#/components/schemas/ReadyToPayMethodFilters"}}}},"components/schemas/AchPlaidFeature":{"id":"components/schemas/AchPlaidFeature","kind":"json-schema","title":"Plaid","data":{"type":"object","title":"Plaid","required":["name","linkToken","expirationTime"],"properties":{"name":{"type":"string","description":"Name of the feature.","enum":["Plaid"]},"linkToken":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plaid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for frontend integrations."},"children":[]}]}]}]},"expirationTime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expires."},"children":[]}]}]}]}}}},"components/schemas/ReadyToPayAchMethodFeature":{"id":"components/schemas/ReadyToPayAchMethodFeature","kind":"json-schema","title":"ReadyToPayAchMethodFeature","data":{"type":"object","discriminator":{"propertyName":"name","mapping":{"Plaid":"#/components/schemas/AchPlaidFeature"}},"oneOf":[{"$ref":"#/components/schemas/AchPlaidFeature"}]}},"components/schemas/ReadyToPayAchMethod":{"id":"components/schemas/ReadyToPayAchMethod","kind":"json-schema","title":"ACH","data":{"type":"object","title":"ACH","required":["method"],"properties":{"method":{"type":"string","description":"Payment method.","enum":["ach"]},"feature":{"description":"Specific feature of this method.\nFor example, a digital wallet or a processor.\nIf the method does not have any features, this value is null.","oneOf":[{"$ref":"#/components/schemas/ReadyToPayAchMethodFeature"},{"type":"null"}]},"filters":{"$ref":"#/components/schemas/ReadyToPayMethodFilters"}}}},"components/schemas/ReadyToPayGenericMethod":{"id":"components/schemas/ReadyToPayGenericMethod","kind":"json-schema","title":"Generic","data":{"type":"object","title":"Generic","required":["method"],"properties":{"method":{"$ref":"#/components/schemas/AlternativePaymentMethods"},"filters":{"$ref":"#/components/schemas/ReadyToPayMethodFilters"}}}},"components/schemas/PayPalBillingAgreementFeature":{"id":"components/schemas/PayPalBillingAgreementFeature","kind":"json-schema","title":"Billing agreement","data":{"type":"object","title":"Billing agreement","required":["name","paypalMerchantId","paypalClientId","billingAgreementToken","expirationTime"],"properties":{"name":{"type":"string","description":"Name of the feature.","enum":["PayPal billing agreement"]},"paypalMerchantId":{"type":"string","description":"ID of the PayPal merchant."},"paypalClientId":{"type":"string","description":"ID of the PayPal client."},"billingAgreementToken":{"type":"string","description":"PayPal billing agreement token."},"expirationTime":{"type":"string","format":"date-time","description":"Date and time when the billing agreement token expires."}}}},"components/schemas/ReadyToPayPayPalMethodFeature":{"id":"components/schemas/ReadyToPayPayPalMethodFeature","kind":"json-schema","title":"ReadyToPayPayPalMethodFeature","data":{"type":"object","discriminator":{"propertyName":"name","mapping":{"PayPal billing agreement":"#/components/schemas/PayPalBillingAgreementFeature"}},"oneOf":[{"$ref":"#/components/schemas/PayPalBillingAgreementFeature"}]}},"components/schemas/ReadyToPayPayPalMethod":{"id":"components/schemas/ReadyToPayPayPalMethod","kind":"json-schema","title":"PayPal","data":{"type":"object","title":"PayPal","required":["method"],"properties":{"method":{"type":"string","description":"Payment method.","enum":["paypal"]},"feature":{"description":"Specific features of PayPal.","oneOf":[{"$ref":"#/components/schemas/ReadyToPayPayPalMethodFeature"},{"type":"null"}]},"filters":{"$ref":"#/components/schemas/ReadyToPayMethodFilters"}}}},"components/schemas/KlarnaFeature":{"id":"components/schemas/KlarnaFeature","kind":"json-schema","title":"Klarna","data":{"type":"object","title":"Klarna","required":["name","clientToken","sessionId"],"properties":{"name":{"type":"string","description":"Name of the feature.","enum":["Klarna"]},"clientToken":{"type":"string","description":"Klarna client token."},"sessionId":{"type":"string","description":"Klarna session token."}}}},"components/schemas/ReadyToPayKlarnaMethodFeature":{"id":"components/schemas/ReadyToPayKlarnaMethodFeature","kind":"json-schema","title":"ReadyToPayKlarnaMethodFeature","data":{"type":"object","discriminator":{"propertyName":"name","mapping":{"Klarna":"#/components/schemas/KlarnaFeature"}},"oneOf":[{"$ref":"#/components/schemas/KlarnaFeature"}]}},"components/schemas/ReadyToPayKlarnaMethod":{"id":"components/schemas/ReadyToPayKlarnaMethod","kind":"json-schema","title":"Klarna","data":{"type":"object","title":"Klarna","required":["method"],"properties":{"method":{"type":"string","description":"Payment method.","enum":["Klarna"]},"feature":{"description":"Specific feature of this method.\nFor example, a digital wallet or a processor.\nIf the method does not have any features, this value is null.","oneOf":[{"$ref":"#/components/schemas/ReadyToPayKlarnaMethodFeature"},{"type":"null"}]},"filters":{"$ref":"#/components/schemas/ReadyToPayMethodFilters"}}}},"components/schemas/ReadyToPayMethods":{"id":"components/schemas/ReadyToPayMethods","kind":"json-schema","title":"ReadyToPayMethods","data":{"type":"object","discriminator":{"propertyName":"method","mapping":{"payment-card":"#/components/schemas/ReadyToPayPaymentCardMethod","ach":"#/components/schemas/ReadyToPayAchMethod","cash":"#/components/schemas/ReadyToPayGenericMethod","check":"#/components/schemas/ReadyToPayGenericMethod","paypal":"#/components/schemas/ReadyToPayPayPalMethod","AdvCash":"#/components/schemas/ReadyToPayGenericMethod","Alfa-click":"#/components/schemas/ReadyToPayGenericMethod","Alipay":"#/components/schemas/ReadyToPayGenericMethod","AstroPay Card":"#/components/schemas/ReadyToPayGenericMethod","AstroPay-GO":"#/components/schemas/ReadyToPayGenericMethod","BankReferenced":"#/components/schemas/ReadyToPayGenericMethod","bank-transfer":"#/components/schemas/ReadyToPayGenericMethod","bank-transfer-2":"#/components/schemas/ReadyToPayGenericMethod","bank-transfer-3":"#/components/schemas/ReadyToPayGenericMethod","bank-transfer-4":"#/components/schemas/ReadyToPayGenericMethod","bank-transfer-5":"#/components/schemas/ReadyToPayGenericMethod","bank-transfer-6":"#/components/schemas/ReadyToPayGenericMethod","bank-transfer-7":"#/components/schemas/ReadyToPayGenericMethod","bank-transfer-8":"#/components/schemas/ReadyToPayGenericMethod","bank-transfer-9":"#/components/schemas/ReadyToPayGenericMethod","Baloto":"#/components/schemas/ReadyToPayGenericMethod","Beeline":"#/components/schemas/ReadyToPayGenericMethod","Belfius-direct-net":"#/components/schemas/ReadyToPayGenericMethod","bitcoin":"#/components/schemas/ReadyToPayGenericMethod","Bizum":"#/components/schemas/ReadyToPayGenericMethod","Boleto":"#/components/schemas/ReadyToPayGenericMethod","cash-deposit":"#/components/schemas/ReadyToPayGenericMethod","CASHlib":"#/components/schemas/ReadyToPayGenericMethod","CashToCode":"#/components/schemas/ReadyToPayGenericMethod","China UnionPay":"#/components/schemas/ReadyToPayGenericMethod","Cleo":"#/components/schemas/ReadyToPayGenericMethod","CODVoucher":"#/components/schemas/ReadyToPayGenericMethod","Conekta-oxxo":"#/components/schemas/ReadyToPayGenericMethod","Cupon-de-pagos":"#/components/schemas/ReadyToPayGenericMethod","cryptocurrency":"#/components/schemas/ReadyToPayGenericMethod","domestic-cards":"#/components/schemas/ReadyToPayGenericMethod","echeck":"#/components/schemas/ReadyToPayGenericMethod","ecoPayz":"#/components/schemas/ReadyToPayGenericMethod","ecoVoucher":"#/components/schemas/ReadyToPayGenericMethod","Efecty":"#/components/schemas/ReadyToPayGenericMethod","EPS":"#/components/schemas/ReadyToPayGenericMethod","ePay.bg":"#/components/schemas/ReadyToPayGenericMethod","eZeeWallet":"#/components/schemas/ReadyToPayGenericMethod","FasterPay":"#/components/schemas/ReadyToPayGenericMethod","Flexepin":"#/components/schemas/ReadyToPayGenericMethod","Giropay":"#/components/schemas/ReadyToPayGenericMethod","Gpaysafe":"#/components/schemas/ReadyToPayGenericMethod","Google Pay":"#/components/schemas/ReadyToPayGenericMethod","iDebit":"#/components/schemas/ReadyToPayGenericMethod","iDEAL":"#/components/schemas/ReadyToPayGenericMethod","ING-homepay":"#/components/schemas/ReadyToPayGenericMethod","INOVAPAY-pin":"#/components/schemas/ReadyToPayGenericMethod","INOVAPAY-wallet":"#/components/schemas/ReadyToPayGenericMethod","InstaDebit":"#/components/schemas/ReadyToPayGenericMethod","instant-bank-transfer":"#/components/schemas/ReadyToPayGenericMethod","InstantPayments":"#/components/schemas/ReadyToPayGenericMethod","Interac":"#/components/schemas/ReadyToPayGenericMethod","Interac-online":"#/components/schemas/ReadyToPayGenericMethod","Interac-eTransfer":"#/components/schemas/ReadyToPayGenericMethod","invoice":"#/components/schemas/ReadyToPayGenericMethod","iWallet":"#/components/schemas/ReadyToPayGenericMethod","Jeton":"#/components/schemas/ReadyToPayGenericMethod","jpay":"#/components/schemas/ReadyToPayGenericMethod","Khelocard":"#/components/schemas/ReadyToPayGenericMethod","Klarna":"#/components/schemas/ReadyToPayKlarnaMethod","KNOT":"#/components/schemas/ReadyToPayGenericMethod","loonie":"#/components/schemas/ReadyToPayGenericMethod","Matrix":"#/components/schemas/ReadyToPayGenericMethod","MaxiCash":"#/components/schemas/ReadyToPayGenericMethod","Megafon":"#/components/schemas/ReadyToPayGenericMethod","MiFinity-eWallet":"#/components/schemas/ReadyToPayGenericMethod","miscellaneous":"#/components/schemas/ReadyToPayGenericMethod","Bancontact":"#/components/schemas/ReadyToPayGenericMethod","Bancontact-mobile":"#/components/schemas/ReadyToPayGenericMethod","MTS":"#/components/schemas/ReadyToPayGenericMethod","MuchBetter":"#/components/schemas/ReadyToPayGenericMethod","Multibanco":"#/components/schemas/ReadyToPayGenericMethod","Neosurf":"#/components/schemas/ReadyToPayGenericMethod","Netbanking":"#/components/schemas/ReadyToPayGenericMethod","Neteller":"#/components/schemas/ReadyToPayGenericMethod","Nordea-Solo":"#/components/schemas/ReadyToPayGenericMethod","OchaPay":"#/components/schemas/ReadyToPayGenericMethod","online-bank-transfer":"#/components/schemas/ReadyToPayGenericMethod","Onlineueberweisen":"#/components/schemas/ReadyToPayGenericMethod","oriental-wallet":"#/components/schemas/ReadyToPayGenericMethod","OXXO":"#/components/schemas/ReadyToPayGenericMethod","P24":"#/components/schemas/ReadyToPayGenericMethod","Pagadito":"#/components/schemas/ReadyToPayGenericMethod","PagoEffectivo":"#/components/schemas/ReadyToPayGenericMethod","Pagsmile-deposit-express":"#/components/schemas/ReadyToPayGenericMethod","Pagsmile-lottery":"#/components/schemas/ReadyToPayGenericMethod","PayCash":"#/components/schemas/ReadyToPayGenericMethod","Payeer":"#/components/schemas/ReadyToPayGenericMethod","PaymentAsia-crypto":"#/components/schemas/ReadyToPayGenericMethod","Paymero":"#/components/schemas/ReadyToPayGenericMethod","Perfect-money":"#/components/schemas/ReadyToPayGenericMethod","Piastrix":"#/components/schemas/ReadyToPayGenericMethod","plaid-account":"#/components/schemas/ReadyToPayGenericMethod","PayTabs":"#/components/schemas/ReadyToPayGenericMethod","Paysafecard":"#/components/schemas/ReadyToPayGenericMethod","Paysafecash":"#/components/schemas/ReadyToPayGenericMethod","Pay4Fun":"#/components/schemas/ReadyToPayGenericMethod","Paynote":"#/components/schemas/ReadyToPayGenericMethod","PinPay":"#/components/schemas/ReadyToPayGenericMethod","phone":"#/components/schemas/ReadyToPayGenericMethod","PhonePe":"#/components/schemas/ReadyToPayGenericMethod","POLi":"#/components/schemas/ReadyToPayGenericMethod","PostFinance-card":"#/components/schemas/ReadyToPayGenericMethod","PostFinance-e-finance":"#/components/schemas/ReadyToPayGenericMethod","QIWI":"#/components/schemas/ReadyToPayGenericMethod","QPay":"#/components/schemas/ReadyToPayGenericMethod","QQPay":"#/components/schemas/ReadyToPayGenericMethod","rapyd-checkout":"#/components/schemas/ReadyToPayGenericMethod","Resurs":"#/components/schemas/ReadyToPayGenericMethod","SafetyPay":"#/components/schemas/ReadyToPayGenericMethod","SEPA":"#/components/schemas/ReadyToPayGenericMethod","Skrill":"#/components/schemas/ReadyToPayGenericMethod","Skrill Rapid Transfer":"#/components/schemas/ReadyToPayGenericMethod","SMSVoucher":"#/components/schemas/ReadyToPayGenericMethod","Sofort":"#/components/schemas/ReadyToPayGenericMethod","SparkPay":"#/components/schemas/ReadyToPayGenericMethod","swift-dbt":"#/components/schemas/ReadyToPayGenericMethod","Tele2":"#/components/schemas/ReadyToPayGenericMethod","Terminaly-RF":"#/components/schemas/ReadyToPayGenericMethod","ToditoCash-card":"#/components/schemas/ReadyToPayGenericMethod","Trustly":"#/components/schemas/ReadyToPayGenericMethod","UPayCard":"#/components/schemas/ReadyToPayGenericMethod","UPI":"#/components/schemas/ReadyToPayGenericMethod","USD-coin":"#/components/schemas/ReadyToPayGenericMethod","VCreditos":"#/components/schemas/ReadyToPayGenericMethod","VenusPoint":"#/components/schemas/ReadyToPayGenericMethod","voucher":"#/components/schemas/ReadyToPayGenericMethod","voucher-2":"#/components/schemas/ReadyToPayGenericMethod","voucher-3":"#/components/schemas/ReadyToPayGenericMethod","voucher-4":"#/components/schemas/ReadyToPayGenericMethod","Webmoney":"#/components/schemas/ReadyToPayGenericMethod","Webpay":"#/components/schemas/ReadyToPayGenericMethod","Webpay-2":"#/components/schemas/ReadyToPayGenericMethod","Webpay Card":"#/components/schemas/ReadyToPayGenericMethod","WeChat Pay":"#/components/schemas/ReadyToPayGenericMethod","XPay-P2P":"#/components/schemas/ReadyToPayGenericMethod","XPay-QR":"#/components/schemas/ReadyToPayGenericMethod","Yandex-money":"#/components/schemas/ReadyToPayGenericMethod","Zotapay":"#/components/schemas/ReadyToPayGenericMethod","Zimpler":"#/components/schemas/ReadyToPayGenericMethod"}},"oneOf":[{"$ref":"#/components/schemas/ReadyToPayPaymentCardMethod"},{"$ref":"#/components/schemas/ReadyToPayAchMethod"},{"$ref":"#/components/schemas/ReadyToPayGenericMethod"},{"$ref":"#/components/schemas/ReadyToPayPayPalMethod"},{"$ref":"#/components/schemas/ReadyToPayKlarnaMethod"}]}},"components/schemas/UsageStatus":{"id":"components/schemas/UsageStatus","kind":"json-schema","title":"UsageStatus","data":{"type":"object","readOnly":true,"description":"Current status of the usage limits.","properties":{"isSoftLimitReached":{"type":"boolean","description":"Specifies if the soft limit has been reached.","example":false},"isHardLimitReached":{"type":"boolean","description":"Specifies if the hard limit has been reached.","example":false},"isTrialLimitReached":{"type":"boolean","description":"Specifies if the trial limit has been reached.","example":false}}}},"components/schemas/SubscriptionOrOneTimeSaleItem":{"id":"components/schemas/SubscriptionOrOneTimeSaleItem","kind":"json-schema","title":"SubscriptionOrOneTimeSaleItem","data":{"type":"object","required":["plan"],"properties":{"id":{"type":"string","description":"ID of the order item.","readOnly":true,"maxLength":50},"planId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field is deprecated. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"plan.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field instead."},"children":[]}]}]}]}],"deprecated":true,"x-basic":true,"type":"string","maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"},"quantity":{"description":"Number of product units in the specified plan.","type":"integer","minimum":0,"maximum":1000000000},"quantityFilled":{"description":"Number of filled product units.","type":"number","format":"double","example":5.125},"plan":{"oneOf":[{"$ref":"#/components/schemas/OriginalPlan"},{"$ref":"#/components/schemas/FlexiblePlan"}]},"usageLimits":{"oneOf":[{"$ref":"#/components/schemas/UsageLimits"},{"type":"null"}],"default":null},"usageStatus":{"oneOf":[{"$ref":"#/components/schemas/UsageStatus"},{"type":"null"}],"default":null},"revision":{"type":"integer","readOnly":true,"description":"Revision number that increments with each overriding change to this specific plan item."},"isModified":{"type":"boolean","readOnly":true,"description":"Specifies if the plan information is modified for this subscription."},"isGrandfathered":{"type":"boolean","readOnly":true,"description":"Specifies if the current plan revision number is greater than the plan item revision number."},"excludeFromMrr":{"type":"boolean","description":"Specifies if this item should be excluded from monthly recurring revenue calculations."},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"product":{"type":"object"}}}}}},"components/schemas/Subscription":{"id":"components/schemas/Subscription","kind":"json-schema","title":"Subscription","data":{"type":"object","required":["orderType","customerId","websiteId","items"],"properties":{"id":{"type":"string","description":"ID of the order.","readOnly":true,"maxLength":50,"example":"sub_01HRF27SATGE4Z6PBJE6PD8328"},"orderType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An order may be a subscription or a one-time purchase."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The order type cannot be changed after creation."},"children":[]}]}]}]}],"type":"string","x-basic":true,"enum":["subscription-order"]},"customerId":{"$ref":"#/components/schemas/CustomerId"},"renewalReminderTime":{"description":"Date and time when the renewal reminder event triggers.","type":["string","null"],"format":"date-time","readOnly":true},"renewalReminderNumber":{"description":"Number of triggered renewal reminder events.","type":["integer","null"],"readOnly":true},"abandonReminderTime":{"description":"Date and time when the abandon order reminder event triggers.","type":["string","null"],"format":"date-time","readOnly":true},"abandonReminderNumber":{"description":"Number of abandon order reminder events that are triggered.","type":["integer","null"],"readOnly":true},"organizationId":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/OrganizationId"}]},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the subscription service."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A subscription starts in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, and becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the service period begins."},"children":[]}]}]}],"type":"string","readOnly":true,"enum":["pending","active","abandoned","canceled","churned","paused","voided","completed","trial-ended"]},"inTrial":{"description":"Specifies if the subscription is currently in a trial period.","type":"boolean","readOnly":true},"trial":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the trial."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use plan defaults, omit the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key or set this value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"enabled":{"description":"Specifies if there is a trial for this subscription.\nPlans without trial prices are free trials.","type":"boolean"},"endTime":{"description":"Time and date when the trial ends.\nIf a trial is enabled on this subscription, a value must be provided.\n\nIf the specified trial end time is in the past, the current time is used.","type":["string","null"],"format":"date-time"}}},"isTrialOnly":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if a subscription ends after a trial period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", recurring settings are ignored."},"children":[]}]}]}],"type":"boolean","default":false},"trialConversionTime":{"description":"Date and time when the subscription had a trial conversion.\nTrial conversion occurs when the first successful payment is made after a trial period.","type":["string","null"],"format":"date-time","readOnly":true},"invoiceTimeShift":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shifts issue time and due time of invoices for this subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This setting overrides plan settings."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use plan settings, set this value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use multiple plans in one subscription,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all plans must have the same billing period,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this property enables the customer to subscribe to different plans."},"children":[]}]}]}],"$ref":"#/components/schemas/InvoiceTimeShift"},"recurringInterval":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring interval to override plan settings."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use plan settings, set this value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use multiple plans in one subscription,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all plans must have the same recurring period length."},"children":[]}]}]}],"example":null,"properties":{"periodAnchorInstruction":{"$ref":"#/components/schemas/ServicePeriodAnchorInstruction"}}},"autopay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if payment attempts are made automatically."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrumentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or the default payment instrument on the subscription."},"children":[]}]}]}],"type":"boolean","default":true},"startTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the subscription starts."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the current time is used."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value cannot be more than one service period in the past."},"children":[]}]}]}],"type":["string","null"],"x-sortable":true,"x-basic":true,"example":null,"default":null,"format":"date-time"},"churnTime":{"description":"Date and time when the subscription is deactivated.","x-sortable":true,"type":["string","null"],"format":"date-time","readOnly":true},"renewalTime":{"description":"Date and time when the subscription renews.","type":["string","null"],"x-sortable":true,"x-basic":true,"format":"date-time"},"currentPeriodStart":{"description":"Date and time of the current service period start.","type":"string","format":"date-time","readOnly":true},"currentPeriodEnd":{"description":"Date and time of the current service period end.","type":"string","format":"date-time","readOnly":true},"rebillNumber":{"description":"Current billing period number.","type":["integer","null"],"readOnly":true,"x-sortable":true},"lineItems":{"description":"Subscription line items which queue until the next renewal, or interim, invoice is issued for the subscription.","readOnly":true,"type":"array","deprecated":true,"items":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice line item."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isInterim"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of upcoming invoice items instead."},"children":[]}]}]}],"deprecated":true,"properties":{"type":{"description":"Type of invoice line item.","type":"string","enum":["debit","credit"]},"description":{"description":"Description of the line item.","type":"string","maxLength":1000},"unitPriceAmount":{"description":"Unit price of the line item.","type":"number","format":"double","example":49.95},"unitPriceCurrency":{"$ref":"#/components/schemas/CurrencyCode"},"quantity":{"description":"Quantity of the line item.","type":"integer","example":1},"periodStartTime":{"description":"Date and time when the service period begins for this item.","type":"string","format":"date-time"},"periodEndTime":{"description":"Date and time when the service period ends for this item.","type":"string","format":"date-time"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"}}}},"lineItemSubtotal":{"type":"object","readOnly":true,"deprecated":true,"description":"Subtotal of line items in this subscription (signed value).\nIf credits exceed debits, this value is a negative number.","properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"type":"number","x-type":"Money","x-sortable":true,"description":"Amount of the subtotal.","format":"double","example":49.95}}},"mrr":{"description":"Monthly recurring revenue of the order.","type":"number","x-type":"Money","x-sortable":true,"format":"double","readOnly":true,"example":49.95},"paymentInstrumentId":{"type":["string","null"],"description":"ID of the payment instrument to use for autopay.\nIf this value is not provided, or if the payment instrument is inactive,\nthe customer's default payment instrument is used.","maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"},"billingStatus":{"description":"Billing status of the most recent invoice.\nThis value may help you to determine if you should change the service status of the service,\nsuch as suspending the service.","type":"string","readOnly":true,"enum":["draft","unpaid","past-due","abandoned","paid","voided","refunded","disputed","partially-refunded","partially-paid"]},"websiteId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the website."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A website is where an organization obtains a customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain an organization ID and website ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The ID of the website cannot be changed after creation."},"children":[]}]}]}]}],"maxLength":50,"example":"web_0YV7DE4Z26DQSA1AC92FBJ7SEG","x-sortable":true,"x-basic":true},"currency":{"description":"Currency of the order.","readOnly":true,"$ref":"#/components/schemas/CurrencyCode"},"initialInvoiceId":{"description":"ID of the initial invoice.","readOnly":true,"type":["string","null"],"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"recentInvoiceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the most recently issued invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice might not be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" yet."},"children":[]}]}]}],"readOnly":true,"type":["string","null"],"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"items":{"description":"Details of items in the order.","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/SubscriptionOrOneTimeSaleItem"}},"deliveryAddress":{"description":"Delivery address of the order.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"billingAddress":{"description":"Billing address of the order.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"activationTime":{"description":"Date and time when the order is activated.","x-sortable":true,"type":["string","null"],"format":"date-time","readOnly":true},"voidTime":{"description":"Date and time when the order is voided.","type":["string","null"],"format":"date-time","readOnly":true},"abandonTime":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the pending order is automatically abandoned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is not passed during order creation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/organizations/patchorganization#organizations/patchorganization/t=request&path=settings/billing/pendingorderttl"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending order TTL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" setting is used to calculate the value."},"children":[]}]}]}],"format":"date-time"},"delinquencyPeriod":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length of time, in ISO-8601 durations format,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which is added to the due time of the order when setting the delinquency time for all related invoices."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the delinquency time of an invoice is reached, the order is automatically canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delinquencyPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the order does not change state and remains active."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must explicitly configure the delinquency period to enable automatic cancellation of unpaid orders."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you add a delinquency period to an active order, it is applied to all new invoices created for the order. It is not applied to the unpaid and past-due invoices. To apply a delinquency period to unpaid and past-due invoices, set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delinquencyTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=delinquencytime"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"upsert an invoice API operation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is not passed during order creation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/organizations/patchorganization#organizations/patchorganization/t=request&path=settings/billing/orderdelinquencyperiod"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order delinquency period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" setting is used to calculate the value."},"children":[]}]}]}],"example":"P7D","default":null},"couponIds":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of coupons to redeem on the customer and restrict to this order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/coupons-and-discounts/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coupons"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter uses the following logic:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this parameter is not supplied, applied coupons are not changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an empty array is supplied, all applied coupon redemptions are canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a list of coupons is supplied, unapplied coupons in the list are applied."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coupons that have already been applied do not change state."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applied coupons that are not supplied in list are canceled."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the list of applied coupons on a pending order is changed by this parameter during an order update, the invoice for the order is reissued."},"children":[]}]}]}],"writeOnly":true,"items":{"type":"string","description":"ID of the coupon."}},"poNumber":{"description":"Purchase order number displayed on the issued invoices.","type":["string","null"],"example":"PO123456"},"shipping":{"$ref":"#/components/schemas/Shipping"},"notes":{"description":"Notes for the customer displayed on the order invoice.","type":"string"},"canceledTime":{"description":"Date and time when a subscription is canceled.","type":["string","null"],"format":"date-time","readOnly":true},"canceledBy":{"description":"Specifies who initiated the cancellation.","type":["string","null"],"readOnly":true,"enum":["merchant","customer","rebilly",null]},"cancelCategory":{"description":"Category of the cancellation.","type":["string","null"],"readOnly":true,"enum":["billing-failure","delinquency","did-not-use","did-not-want","missing-features","bugs-or-problems","do-not-remember","risk-warning","contract-expired","too-expensive","never-started","switched-plan","organization-deactivated","other",null]},"cancelDescription":{"description":"Description of the cancellation reason in free form.","type":["string","null"],"readOnly":true,"maxLength":255},"revision":{"description":"Number of times the order data has been modified.\n\nThe revision is useful when analyzing webhook data to determine if the\nchange takes precedence over the current representation.","type":"integer","readOnly":true},"riskMetadata":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk metadata."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field uses risk metadata that is captured when creating the payment token."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"billingPortalToken":{"description":"Customer JWT to access a billing portal.\nThis field is presented only if a billing portal exists.\nThis is an experimental field and can be changed or removed in the future.","type":["string","null"],"readOnly":true},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","website","customer","initialInvoice","recentInvoice","approvalUrl","attachments"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"recentInvoice":{"type":"object"},"initialInvoice":{"type":"object"},"customer":{"type":"object"},"website":{"type":"object"},"leadSource":{"type":"object"},"shippingRate":{"type":"object"},"paymentInstrument":{"type":"object"},"upcomingInvoice":{"type":"object"}}}}}},"components/schemas/OneTimeSale":{"id":"components/schemas/OneTimeSale","kind":"json-schema","title":"OneTimeSale","data":{"type":"object","required":["orderType","customerId","websiteId","items"],"properties":{"id":{"type":"string","description":"ID of the one-time sale.","readOnly":true,"maxLength":50,"example":"ots_01HRF27SATGE4Z6PBJE6PD8328"},"orderType":{"description":"Specifies the type of order.\nAn order may be a subscription or a one-time purchase.","type":"string","x-basic":true,"enum":["one-time-order"]},"customerId":{"$ref":"#/components/schemas/CustomerId"},"organizationId":{"deprecated":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/OrganizationId"}]},"status":{"description":"Status of the one-time order.","type":"string","readOnly":true,"enum":["pending","abandoned","completed","canceled"]},"billingStatus":{"description":"Billing status of the most recent invoice.\nThis value may help you to determine if you should change the service status of the service,\nsuch as suspending the service.","type":"string","readOnly":true,"enum":["draft","unpaid","past-due","abandoned","paid","voided","refunded","disputed","partially-refunded","partially-paid"]},"websiteId":{"x-sortable":true,"x-basic":true,"allOf":[{"$ref":"#/components/schemas/WebsiteId"}]},"currency":{"description":"Currency of the order.","readOnly":true,"$ref":"#/components/schemas/CurrencyCode"},"initialInvoiceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the initial invoice ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for one-time orders)."},"children":[]}]}]}],"readOnly":true,"type":["string","null"],"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"recentInvoiceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the most recently issued invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice might not be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" yet."},"children":[]}]}]}],"readOnly":true,"type":["string","null"],"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"items":{"description":"Details of items in the order.","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/SubscriptionOrOneTimeSaleItem"}},"deliveryAddress":{"description":"Delivery address of the order.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"billingAddress":{"description":"Billing address of the order.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"activationTime":{"description":"Date and time when the order is activated.","x-sortable":true,"type":["string","null"],"format":"date-time","readOnly":true},"voidTime":{"description":"Date and time when the order is voided.","type":["string","null"],"format":"date-time","readOnly":true},"abandonTime":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the pending order is automatically abandoned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is not passed during order creation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/organizations/patchorganization#organizations/patchorganization/t=request&path=settings/billing/pendingorderttl"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending order TTL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" setting is used to calculate the value."},"children":[]}]}]}],"format":"date-time"},"couponIds":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of coupons to redeem on the customer and restrict to this order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/coupons-and-discounts/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coupons"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter uses the following logic:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this parameter is not supplied, applied coupons are not changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an empty array is supplied, all applied coupon redemptions are canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a list of coupons is supplied, unapplied coupons in the list are applied."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coupons that have already been applied do not change state."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applied coupons that are not supplied in list are canceled."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the list of applied coupons on a pending order is changed by this parameter during an order update, the invoice for the order is reissued."},"children":[]}]}]}],"writeOnly":true,"items":{"type":"string","description":"ID of the coupon."}},"poNumber":{"description":"Purchase order number displayed on the issued invoices.","type":["string","null"],"example":"PO123456"},"shipping":{"$ref":"#/components/schemas/Shipping"},"notes":{"description":"Notes for the customer displayed on the order invoice.","type":"string"},"revision":{"description":"Number of times the order data has been modified.\n\nThe revision is useful when analyzing webhook data to determine if the\nchange takes precedence over the current representation.","type":"integer","readOnly":true},"riskMetadata":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk metadata."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field uses risk metadata that is captured when creating the payment token."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","website","customer","initialInvoice","recentInvoice","approvalUrl","attachments"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"recentInvoice":{"type":"object"},"customer":{"type":"object"},"website":{"type":"object"},"leadSource":{"type":"object"},"shippingRate":{"type":"object"},"paymentInstrument":{"type":"object"}}}}}},"components/schemas/SubscriptionOrOneTimeSale":{"id":"components/schemas/SubscriptionOrOneTimeSale","kind":"json-schema","title":"SubscriptionOrOneTimeSale","data":{"type":"object","description":"Subscription details.","discriminator":{"propertyName":"orderType","mapping":{"subscription-order":"#/components/schemas/Subscription","one-time-order":"#/components/schemas/OneTimeSale"}},"oneOf":[{"$ref":"#/components/schemas/Subscription"},{"$ref":"#/components/schemas/OneTimeSale"}]}},"components/schemas/Search":{"id":"components/schemas/Search","kind":"json-schema","title":"Search","data":{"type":"object","properties":{"customers":{"description":"List of returned customers.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Customer"}},"invoices":{"description":"List of returned invoices.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Invoice"}},"orders":{"description":"List of returned orders.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/SubscriptionOrOneTimeSale"}},"transactions":{"description":"List of returned transactions.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Transaction"}},"searched":{"description":"Names of searched resources.\nIncludes all searched resources.","readOnly":true,"type":"array","items":{"type":"string"}}}}},"components/schemas/ShippingOption":{"id":"components/schemas/ShippingOption","kind":"json-schema","title":"ShippingOption","data":{"type":"object","required":["name","price","currency"],"properties":{"id":{"type":"string","description":"ID of the shipping rate.","readOnly":true,"maxLength":50,"example":"ship_rate_0YVDN408G4DQE9G1RV1QCFHJ3P"},"name":{"type":"string","description":"Name of the shipping rate."},"description":{"type":["string","null"],"description":"Description of the shipping rate."},"price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price of the shipping rate."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", shipping is free."},"children":[]}]}]}],"type":"number","format":"double"},"currency":{"$ref":"#/components/schemas/CurrencyCode"}}}},"components/schemas/ShippingRate":{"id":"components/schemas/ShippingRate","kind":"json-schema","title":"ShippingRate","data":{"allOf":[{"$ref":"#/components/schemas/ShippingOption"},{"properties":{"filter":{"type":"string","description":"Filter based on invoice properties that is used to determine when the rate is applicable.\nIf no filters are used, the rate is always applicable.","default":"","example":"deliveryAddress.country:US,CA,RU;amount:100..1000"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the shipping rate."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the shipping rate is not applied."},"children":[]}]}]}],"type":"string","enum":["active","inactive"],"default":"active"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}]}},"components/schemas/OneTimeSaleItem":{"id":"components/schemas/OneTimeSaleItem","kind":"json-schema","title":"OneTimeSaleItem","data":{"type":"object","required":["type","plan"],"properties":{"id":{"type":"string","description":"ID of the one-time sale.","readOnly":true,"maxLength":50,"example":"ots_01HRF27SATGE4Z6PBJE6PD8328"},"type":{"description":"Specifies the type of order item.","type":"string","x-basic":true,"const":"one-time-sale"},"planId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field is deprecated. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"plan.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field instead."},"children":[]}]}]}]}],"x-basic":true,"type":"string","maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X","deprecated":true},"productId":{"type":"string","description":"ID of the related product.","maxLength":50,"example":"prod_0YV7DES3WPC5J8JD8QTVNZBZNZ","readOnly":true},"plan":{"description":"Details of the plan.","oneOf":[{"$ref":"#/components/schemas/OriginalPlan"},{"$ref":"#/components/schemas/FlexiblePlan"}]},"quantity":{"description":"Number of product units in the specified plan.","type":"integer","minimum":0,"maximum":1000000000},"revision":{"description":"Number of times the order data has been modified.\n\nThe revision is useful when analyzing webhook data to determine if the\nchange takes precedence over the current representation.","type":"integer","readOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"}}}},"components/schemas/SubscriptionItem":{"id":"components/schemas/SubscriptionItem","kind":"json-schema","title":"SubscriptionItem","data":{"type":"object","required":["type","plan"],"properties":{"id":{"type":"string","description":"ID of the subscription.","readOnly":true,"maxLength":50,"example":"sub_01HRF27SATGE4Z6PBJE6PD8328"},"type":{"description":"Specifies the type of order item.","type":"string","x-basic":true,"const":"subscription"},"renewalReminderTime":{"description":"Date and time when the renewal reminder event triggers.","type":["string","null"],"format":"date-time","readOnly":true},"renewalReminderNumber":{"description":"Number of triggered renewal reminder events.","type":["integer","null"],"readOnly":true},"recurringInterval":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring interval to override plan settings."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use plan settings, set this value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use multiple plans in one subscription,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all plans must have the same recurring period length."},"children":[]}]}]}],"example":null,"properties":{"periodAnchorInstruction":{"$ref":"#/components/schemas/ServicePeriodAnchorInstruction"}}},"renewalTime":{"description":"Date and time when the subscription renews.","type":["string","null"],"x-sortable":true,"x-basic":true,"format":"date-time"},"currentPeriodStart":{"description":"Date and time of the current service period start.","type":"string","format":"date-time","readOnly":true},"currentPeriodEnd":{"description":"Date and time of the current service period end.","type":"string","format":"date-time","readOnly":true},"rebillNumber":{"description":"Current billing period number.","type":["integer","null"],"readOnly":true,"x-sortable":true},"planId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field is deprecated. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"plan.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field instead."},"children":[]}]}]}]}],"x-basic":true,"type":"string","maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X","deprecated":true},"productId":{"type":"string","description":"ID of the related product.","maxLength":50,"example":"prod_0YV7DES3WPC5J8JD8QTVNZBZNZ","readOnly":true},"plan":{"description":"Details of the plan.","oneOf":[{"$ref":"#/components/schemas/OriginalPlan"},{"$ref":"#/components/schemas/FlexiblePlan"}]},"quantity":{"description":"Number of product units in the specified plan.","type":"integer","minimum":0,"maximum":1000000000},"quantityFilled":{"description":"Number of filled product units.","type":["number","null"],"format":"double","example":5.125},"usageLimits":{"oneOf":[{"$ref":"#/components/schemas/UsageLimits"},{"type":"null"}],"default":null},"usageStatus":{"oneOf":[{"$ref":"#/components/schemas/UsageStatus"},{"type":"null"}],"default":null},"revision":{"type":"integer","readOnly":true,"description":"Revision number that increments with each overriding change to this specific item."},"excludeFromMrr":{"type":"boolean","description":"Specifies if this item should be excluded from monthly recurring revenue calculations."},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"}}}},"components/schemas/OrderUpcomingInvoiceItem":{"id":"components/schemas/OrderUpcomingInvoiceItem","kind":"json-schema","title":"OrderUpcomingInvoiceItem","data":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","description":"ID of the upcoming invoice item.","maxLength":50,"example":"ii_0YVFDEQS2KCFTBN9HXWJFY55GV"},"isInterim":{"description":"Specifies if the line item is added to an interim invoice.","type":"boolean"},"description":{"description":"Description of the upcoming invoice item.","type":"string","maxLength":1000},"unitPrice":{"description":"Unit price of the upcoming invoice item.","type":"number","format":"double"},"quantity":{"description":"Quantity of the upcoming invoice item.","type":"integer"},"price":{"description":"Total price of the upcoming invoice item.","type":"number","format":"double"},"productId":{"type":["string","null"],"description":"ID of the product.","maxLength":50,"example":"prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"},"planId":{"type":["string","null"],"description":"ID of the plan.","maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"},"orderId":{"type":"string","description":"ID of the order.","maxLength":50,"example":"ord_01HVKA5975PJBSQ1SX72G3MSZC"},"periodStartTime":{"description":"Date and time when the billing period starts.","type":"string","format":"date-time"},"periodEndTime":{"description":"Date and time when the billing period ends.","type":"string","format":"date-time"},"periodNumber":{"description":"Billing period number that is associated with the invoice item.\nFor example, an invoice item for a service is included in billing period number 3.\nThe invoice item is only applied to billing period number 3.","type":"integer"},"tax":{"description":"Invoice item tax.","$ref":"#/components/schemas/TaxItem"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/OrderUpcomingInvoice":{"id":"components/schemas/OrderUpcomingInvoice","kind":"json-schema","title":"OrderUpcomingInvoice","data":{"type":"object","readOnly":true,"properties":{"id":{"description":"ID of the upcoming invoice.\nThis value is persisted in the future renewal invoice.","type":"string","readOnly":true,"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"currency":{"x-sortable":true,"x-basic":true,"$ref":"#/components/schemas/CurrencyCode"},"revision":{"description":"Number of times the upcoming invoice data has changed.\n\nUse the revision number when analyzing webhook data to\ndetermine if a change should take precedence over the current\nrepresentation.","type":"integer"},"items":{"type":"array","description":"Upcoming invoice items array.","items":{"$ref":"#/components/schemas/OrderUpcomingInvoiceItem"}},"amount":{"description":"Amount of the invoice.","type":"number","x-type":"Money","x-sortable":true,"x-basic":true,"format":"double","readOnly":true},"amountDue":{"description":"Amount that is due on the invoice.","type":"number","x-type":"Money","x-sortable":true,"format":"double","readOnly":true},"subtotalAmount":{"description":"Subtotal amount of the invoice.","type":"number","x-type":"Money","format":"double","readOnly":true},"discountAmount":{"description":"Discount amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double","readOnly":true},"shipping":{"$ref":"#/components/schemas/Shipping"},"tax":{"$ref":"#/components/schemas/Taxes"},"discounts":{"type":"array","description":"Discounts applied.","readOnly":true,"items":{"type":"object","readOnly":true,"properties":{"couponId":{"type":"string","description":"ID of the coupon.","maxLength":50,"example":"cpn_0YVCNKF81GD778N4YNVGDJK558"},"redemptionId":{"description":"ID of the redemption.","$ref":"#/components/schemas/ResourceId"},"amount":{"description":"Total amount discounted by this coupon.","type":"number","format":"double"},"description":{"type":"string","description":"Description of the discount."},"context":{"$ref":"#/components/schemas/DiscountContext"}}}},"issuedTime":{"description":"Date and time when the invoice is issued.","x-label":"Date Issued","x-sortable":true,"x-basic":true,"$ref":"#/components/schemas/ServerTimestamp"},"isNewOrder":{"description":"Specifies if the order is a new order.","type":"boolean","readOnly":true,"example":true},"dueTime":{"description":"Date and time when the invoice is due for payment.","type":"string","x-sortable":true,"format":"date-time"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/Website":{"id":"components/schemas/Website","kind":"json-schema","title":"Website","data":{"type":"object","required":["name","url","servicePhone","serviceEmail"],"properties":{"id":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/WebsiteId"}]},"name":{"description":"Name of the website.","type":"string"},"url":{"description":"Domain address of the website.","type":"string"},"servicePhone":{"description":"Customer service phone number of the website.","type":"string"},"serviceEmail":{"description":"Customer service email address of the website.","type":"string","format":"email"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"settings":{"type":"object","description":"Website settings.","properties":{"depositForm":{"type":"object","description":"Deposit form settings.","properties":{"theme":{"description":"Theme settings that are used in the deposit form.","type":["object","null"],"properties":{"colorPrimary":{"description":"Primary color for the deposit form in hexadecimal format.","type":["string","null"],"maxLength":6,"example":"0044d4"},"colorSecondary":{"description":"Secondary color for the deposit form in hexadecimal format.","type":["string","null"],"maxLength":6,"example":"ffffff"},"buttonTemplate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit button template. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{amount}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used as a placeholder for amount and currency."},"children":[]}]}]}],"type":["string","null"],"maxLength":100,"example":"Pay {{amount}}"}}}}},"paymentForm":{"type":"object","description":"Payment form settings.","properties":{"css":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hosted payment form "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#2-use-css-property-to-override-any-styles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSS options"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"]},"theme":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hosted payment form "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#adjust-the-default-style"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"theme options"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["object","null"],"additionalProperties":{"type":"string"},"example":{"colorPrimary":"#504CCA"}},"features":{"description":"Hosted payment form features.","type":["object","null"],"properties":{"showCoupons":{"type":["array","null"],"items":{"type":"string"}},"fullPageRedirect":{"type":["boolean","null"],"description":"Specifies whether the hosted payment form uses a full page redirect, or the default iframe modal, for approval URL redirects.","default":false},"skipRedirectOnPaymentComplete":{"type":["boolean","null"],"description":"Specifies whether the hosted payment form skips the redirect to the website URL when the payment is completed.","default":false},"hideZeroAmountSummaryItems":{"type":["boolean","null"],"description":"Specifies if the hosted payment form displays 0 amount line items in the summary.","default":false}}}}},"amplitude":{"type":"object","description":"Amplitude settings.\nAmplitude is an analytics tool for tracking user behavior.","properties":{"tracking":{"description":"Specifies if the hosted pages, such as KYC pages, include Amplitude analytics.","type":"boolean","default":false},"apiKey":{"description":"API key of an Amplitude project.","type":["string","null"],"minLength":20,"maxLength":50,"example":"35d1795750c585984f7e6b01c0ca6e19"}}},"payoutRequest":{"type":"object","description":"Payout request settings for the website.","properties":{"automaticReadinessEnabled":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether pending payout requests are automatically marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", payout requests are created in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status and automatic transition is not used."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", payout requests remain in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status until the pending period elapses and the configured transition time is reached."},"children":[]}]}]}]},"pendingPeriodHours":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum number of hours a payout request stays in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status before it can be automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"automaticReadinessEnabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minimum":1,"maximum":8760,"example":48},"automaticReadinessTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time of day when the automatic readiness job processes eligible pending payout requests."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"automaticReadinessEnabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use extended ISO-8601 time format ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:MM:SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") with an optional timezone offset."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the timezone offset is omitted, the server timezone is used."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/TimeIso8601Extended"}],"example":"10:00:00Z"},"automaticReadinessLastExecutedAt":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"Date and time when the automatic readiness job last completed successfully for this website."}}}}},"logoId":{"type":["string","null"],"description":"ID of the linked file object.","maxLength":50,"example":"4f6cf35x-2c4y-483z-a0a9-158621f77a21"},"logoUrl":{"readOnly":true,"description":"URL of the website logo.","type":["string","null"]},"organizationId":{"deprecated":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/OrganizationId"}]},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","logoUrl"]}}}}}}},"components/schemas/RecurringOrder":{"id":"components/schemas/RecurringOrder","kind":"json-schema","title":"RecurringOrder","data":{"type":"object","required":["type","customerId","websiteId","items"],"properties":{"id":{"type":"string","description":"ID of the order.","readOnly":true,"maxLength":50,"example":"ord_01HVKA5975PJBSQ1SX72G3MSZC"},"type":{"type":"string","description":"Type of the order.","const":"recurring"},"organizationId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique organization identifier."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An organization is an entity that represents a company."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain an organization ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":50,"readOnly":true,"example":"org_0YVDM8RC7GDADADSBSMW124JA8"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"websiteId":{"$ref":"#/components/schemas/WebsiteId"},"activationInvoiceId":{"type":"string","description":"ID of the activation invoice.","readOnly":true,"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"recentInvoiceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the most recently issued invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice might not be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" yet."},"children":[]}]}]}],"readOnly":true,"type":["string","null"],"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"status":{"description":"Status of the order.","type":"string","readOnly":true,"enum":["pending","active","canceled","churned","paused","voided","completed","trial-ended","abandoned"]},"inTrial":{"description":"Specifies if the subscription is currently in a trial period.","type":"boolean","readOnly":true},"trial":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the trial."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use plan defaults, omit the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key or set this value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"enabled":{"description":"Specifies if there is a trial for this subscription.\nPlans without trial prices are free trials.","type":"boolean"},"endTime":{"description":"Time and date when the trial ends.\nIf a trial is enabled on this subscription, a value must be provided.\n\nIf the specified trial end time is in the past, the current time is used.","type":["string","null"],"format":"date-time"}}},"isTrialOnly":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if a subscription ends after a trial period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", recurring settings are ignored."},"children":[]}]}]}],"type":"boolean","default":false},"trialConversionTime":{"description":"Date and time when the subscription had a trial conversion.\nTrial conversion occurs when the first successful payment is made after a trial period.","type":["string","null"],"format":"date-time","readOnly":true},"items":{"type":"array","minItems":1,"description":"Item in the order.","items":{"type":"object","discriminator":{"propertyName":"type","mapping":{"one-time-sale":"#/components/schemas/OneTimeSaleItem","subscription":"#/components/schemas/SubscriptionItem"}},"oneOf":[{"$ref":"#/components/schemas/SubscriptionItem"},{"$ref":"#/components/schemas/OneTimeSaleItem"}]}},"invoiceIssueTimeShift":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice issue time shift interval in ISO-8601 format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field adjusts the issue date and time of renewal invoices for the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This interval value supports the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" symbol."},"children":[]}]}]}],"type":"string","default":"+P00Y00M00DT00H00M00S","example":"+P00Y00M00DT00H00M00S"},"invoiceDueTimeShift":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice due time shift interval in ISO-8601 format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to adjust when payment is due for the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If autopay is configured, payment is collected automatically on this date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This interval value supports the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" symbol."},"children":[]}]}]}],"type":"string","default":"+P00Y00M00DT00H00M00S","example":"+P00Y00M00DT00H00M00S"},"paymentInstrumentId":{"type":["string","null"],"description":"ID of the payment instrument to use for autopay.\nIf this value is not provided, or if the payment instrument is inactive,\nthe customer's default payment instrument is used.","maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"},"poNumber":{"description":"Purchase order number that is displayed on the issued invoices.","type":["string","null"],"example":"PO123456"},"notes":{"description":"Notes for the customer that are displayed on the order invoice.","type":"string"},"billingAddress":{"description":"Billing address of the order.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"deliveryAddress":{"description":"Delivery address of the order.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"delinquencyPeriod":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length of time, in ISO-8601 durations format,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which is added to the due time of the order when setting the delinquency time for all related invoices."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the delinquency time of an invoice is reached, the order is automatically canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the provided value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the order does not change state."},"children":[]}]}]}],"example":"+P00Y00M07DT00H00M00S","default":null},"couponIds":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of coupons to redeem on the customer and restrict to this order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/coupons-and-discounts/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coupons"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter uses the following logic:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this parameter is not supplied, applied coupons are not changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an empty array is supplied, all applied coupon redemptions are canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a list of coupons is supplied, unapplied coupons in the list are applied."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coupons that have already been applied do not change state."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applied coupons that are not supplied in list are canceled."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the list of applied coupons on a pending order is changed by this parameter during an order update, the invoice for the order is reissued."},"children":[]}]}]}],"writeOnly":true,"items":{"type":"string","description":"ID of the coupon."}},"riskMetadata":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk metadata."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field uses risk metadata that is captured when creating the payment token."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"startTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the subscription starts."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the current time is used."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value cannot be more than one service period in the past."},"children":[]}]}]}],"type":["string","null"],"x-sortable":true,"x-basic":true,"example":null,"default":null,"format":"date-time"},"activationTime":{"description":"Date and time when the order is activated.","x-sortable":true,"type":["string","null"],"format":"date-time","readOnly":true},"currency":{"description":"Currency of the order.","readOnly":true,"$ref":"#/components/schemas/CurrencyCode"},"shipping":{"$ref":"#/components/schemas/Shipping"},"autopay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if payment attempts are made automatically."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentInstrumentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or the default payment instrument on the order."},"children":[]}]}]}],"type":"boolean","default":true},"abandonTime":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the pending order is automatically abandoned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is not passed during order creation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/organizations/patchorganization/#!t=request&path=settings/billing/pendingOrderTtl"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending order TTL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" setting is used to calculate the value."},"children":[]}]}]}],"format":"date-time"},"abandonReminderTime":{"description":"Date and time when the abandon order reminder event triggers.","type":["string","null"],"format":"date-time","readOnly":true},"abandonReminderNumber":{"description":"Number of abandon order reminder events that are triggered.","type":["integer","null"],"readOnly":true},"voidTime":{"description":"Date and time when the order is voided.","type":["string","null"],"format":"date-time","readOnly":true},"churnTime":{"description":"Date and time when the order is deactivated.","x-sortable":true,"type":["string","null"],"format":"date-time","readOnly":true},"cancellationTime":{"description":"Date and time when an order is canceled.","type":["string","null"],"format":"date-time","readOnly":true},"canceledBy":{"description":"Specifies who initiated the cancellation.","type":["string","null"],"readOnly":true,"enum":["merchant","customer","rebilly",null]},"cancelCategory":{"description":"Category of the cancellation.","type":["string","null"],"readOnly":true,"enum":["billing-failure","did-not-use","did-not-want","missing-features","bugs-or-problems","do-not-remember","risk-warning","contract-expired","too-expensive","never-started","switched-plan","other",null]},"cancelDescription":{"description":"Description of the cancellation reason in free form.","type":["string","null"],"readOnly":true,"maxLength":255},"billingPortalToken":{"description":"Customer JWT to access a billing portal.\nThis field is presented only if a billing portal exists.\nThis is an experimental field and can be changed or removed in the future.","type":["string","null"],"readOnly":true},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"mrr":{"description":"Monthly recurring revenue of the order.","type":"number","x-type":"Money","x-sortable":true,"format":"double","readOnly":true,"example":49.95},"revision":{"description":"Number of times the order data has been modified.\n\nThe revision is useful when analyzing webhook data to determine if the\nchange takes precedence over the current representation.","type":"integer","readOnly":true},"currentPeriodStart":{"description":"Date and time of the current service period start.","type":["string","null"],"format":"date-time","readOnly":true},"currentPeriodEnd":{"description":"Date and time of the current service period end.\nIf subscriptions have different recurring settings or the order is not active, providing this field causes the request to be rejected with a conflict.\nThis field is ignored if the order is in trial.","type":["string","null"],"format":"date-time"},"renewalTime":{"description":"Date and time when the next subscription in this recurring order renews.","type":["string","null"],"format":"date-time","readOnly":true},"isNewOrder":{"description":"Specifies if the order is a new order.","type":"boolean","readOnly":true,"example":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"$ref":"#/components/schemas/Customer"},"activationInvoice":{"$ref":"#/components/schemas/Invoice"},"recentInvoice":{"$ref":"#/components/schemas/Invoice"},"upcomingInvoice":{"$ref":"#/components/schemas/OrderUpcomingInvoice"},"paymentInstrument":{"$ref":"#/components/schemas/PaymentInstrument"},"website":{"$ref":"#/components/schemas/Website"}}}}}},"components/schemas/OneTimeOrder":{"id":"components/schemas/OneTimeOrder","kind":"json-schema","title":"OneTimeOrder","data":{"type":"object","required":["type","customerId","websiteId","items"],"properties":{"id":{"type":"string","description":"ID of the order.","readOnly":true,"maxLength":50,"example":"ord_01HVKA5975PJBSQ1SX72G3MSZC"},"type":{"type":"string","description":"Type of the order.","const":"one-time"},"organizationId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique organization identifier."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An organization is an entity that represents a company."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain an organization ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":50,"readOnly":true,"example":"org_0YVDM8RC7GDADADSBSMW124JA8"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"websiteId":{"$ref":"#/components/schemas/WebsiteId"},"activationInvoiceId":{"type":"string","description":"ID of the activation invoice.","readOnly":true,"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"recentInvoiceId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the most recently issued invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice might not be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" yet."},"children":[]}]}]}],"readOnly":true,"type":["string","null"],"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"status":{"description":"Status of the order.","type":"string","readOnly":true,"enum":["pending","voided","completed","abandoned"]},"items":{"type":"array","minItems":1,"description":"Item in the order.","items":{"$ref":"#/components/schemas/OneTimeSaleItem"}},"poNumber":{"description":"Purchase order number that is displayed on the issued invoices.","type":["string","null"],"example":"PO123456"},"notes":{"description":"Notes for the customer that are displayed on the order invoice.","type":"string"},"billingAddress":{"description":"Billing address of the order.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"deliveryAddress":{"description":"Delivery address of the order.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"delinquencyPeriod":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length of time, in ISO-8601 durations format,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which is added to the due time of the order when setting the delinquency time for all related invoices."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the delinquency time of an invoice is reached, the order is automatically canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the provided value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the order does not change state."},"children":[]}]}]}],"example":"+P00Y00M07DT00H00M00S","default":null},"couponIds":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of coupons to redeem on the customer and restrict to this order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/coupons-and-discounts/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coupons"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter uses the following logic:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this parameter is not supplied, applied coupons are not changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an empty array is supplied, all applied coupon redemptions are canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a list of coupons is supplied, unapplied coupons in the list are applied."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coupons that have already been applied do not change state."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applied coupons that are not supplied in list are canceled."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the list of applied coupons on a pending order is changed by this parameter during an order update, the invoice for the order is reissued."},"children":[]}]}]}],"writeOnly":true,"items":{"type":"string","description":"ID of the coupon."}},"riskMetadata":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk metadata."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field uses risk metadata that is captured when creating the payment token."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"activationTime":{"description":"Date and time when the order is activated.","x-sortable":true,"type":["string","null"],"format":"date-time","readOnly":true},"currency":{"description":"Currency of the order.","readOnly":true,"$ref":"#/components/schemas/CurrencyCode"},"shipping":{"$ref":"#/components/schemas/Shipping"},"abandonTime":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the pending order is automatically abandoned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is not passed during order creation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/organizations/patchorganization/#!t=request&path=settings/billing/pendingOrderTtl"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending order TTL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" setting is used to calculate the value."},"children":[]}]}]}],"format":"date-time"},"abandonReminderTime":{"description":"Date and time when the abandon order reminder event triggers.","type":["string","null"],"format":"date-time","readOnly":true},"abandonReminderNumber":{"description":"Number of abandon order reminder events that are triggered.","type":["integer","null"],"readOnly":true},"voidTime":{"description":"Date and time when the order is voided.","type":["string","null"],"format":"date-time","readOnly":true},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"revision":{"description":"Number of times the order data has been modified.\n\nThe revision is useful when analyzing webhook data to determine if the\nchange takes precedence over the current representation.","type":"integer","readOnly":true},"isNewOrder":{"description":"Specifies if the order is a new order.","type":"boolean","readOnly":true,"example":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"$ref":"#/components/schemas/Customer"},"activationInvoice":{"$ref":"#/components/schemas/Invoice"},"recentInvoice":{"$ref":"#/components/schemas/Invoice"},"upcomingInvoice":{"$ref":"#/components/schemas/OrderUpcomingInvoice"},"paymentInstrument":{"$ref":"#/components/schemas/PaymentInstrument"},"website":{"$ref":"#/components/schemas/Website"}}}}}},"components/schemas/Order":{"id":"components/schemas/Order","kind":"json-schema","title":"Order","data":{"type":"object","discriminator":{"propertyName":"type","mapping":{"recurring":"#/components/schemas/RecurringOrder","one-time":"#/components/schemas/OneTimeOrder"}},"oneOf":[{"$ref":"#/components/schemas/RecurringOrder"},{"$ref":"#/components/schemas/OneTimeOrder"}]}},"components/schemas/OrderPause":{"id":"components/schemas/OrderPause","kind":"json-schema","title":"OrderPause","data":{"type":"object","description":"Order pause details.","required":["orderId"],"properties":{"id":{"type":"string","description":"ID of the order pause.","readOnly":true,"maxLength":50,"example":"sub_pau_01H085J3ZR1WKD120D73D7N4C9"},"orderId":{"type":"string","description":"ID of the paused order.","maxLength":50,"example":"ord_01HVKA5975PJBSQ1SX72G3MSZC"},"status":{"description":"Status of the order pause.","type":"string","readOnly":true,"enum":["pending","ongoing","revoked","finished"]},"pausedBy":{"description":"Specifies who initiated the pause.","type":"string","default":"customer","enum":["merchant","customer"]},"description":{"description":"Description of the pause reason in free form.","type":["string","null"],"maxLength":255},"effectiveTime":{"description":"Date and time when the service period pauses.\n\nThis time must be later than the current time.\nIf this time is earlier then the current time, the current time is used.\n\nIf this field is omitted, this value defaults to the current time.","type":["string","null"],"format":"date-time"},"endTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the pause ends and the order resumes billing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To resume a order from this point in time,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"use the current time or an earlier time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is earlier then the current time, the current time is used."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is empty, the order is indefinitely paused."},"children":[]}]}]}],"type":["string","null"],"format":"date-time"},"timeRemaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of time between the pause end time and the renewal time in ISO-8601 durations format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, this value is computed as the time between the pause and the renewal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: A $30 per month subscription on a 30-day month is paused on day 20 of the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are 10 unused days on the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Therefore, the order renews in 10 days after it is resumed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The upcoming invoice does not change the amount for the invoiced period, it remains at $30."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the order uses a billing anchor,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the renewal time after a pause shift behaves as though the renewal time is moved forward by an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order API operation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the billing anchor is ignored for that period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service period anchor, billing timing, and invoice time shift"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"example":"P3600S"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/OrderCancellation":{"id":"components/schemas/OrderCancellation","kind":"json-schema","title":"OrderCancellation","data":{"type":"object","required":["orderId"],"properties":{"id":{"type":"string","description":"ID of the cancellation.","readOnly":true,"maxLength":50,"example":"sub_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV"},"orderId":{"type":"string","description":"ID of the canceled order.","maxLength":50,"example":"sub_01HRF27SATGE4Z6PBJE6PD8328"},"proratedInvoiceId":{"type":["string","null"],"description":"ID of the invoice on which the cancellation proration is calculated.","readOnly":true,"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"appliedInvoiceId":{"type":["string","null"],"description":"ID of the invoice on which the cancellation fees or credits are applied.","readOnly":true,"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"canceledBy":{"description":"Specifies who initiated the cancellation.","type":"string","default":"customer","enum":["merchant","customer","rebilly"]},"reason":{"description":"Reason for the cancellation.","type":"string","default":"other","enum":["did-not-use","did-not-want","missing-features","bugs-or-problems","do-not-remember","risk-warning","contract-expired","too-expensive","other","billing-failure"]},"description":{"description":"Description of the cancellation reason in free form.","type":"string","maxLength":255},"prorated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the customer gets a pro-rata credit for the time remaining between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"churnTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and order next renewal time."},"children":[]}]}]}],"type":"boolean","default":false},"status":{"description":"Status of the order cancellation.","type":"string","default":"confirmed","enum":["draft","confirmed","completed","revoked"],"x-enumDescriptions":{"draft":"Creates a draft cancellation so that the cancellation and charge can be previewed.","confirmed":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirms an order cancellation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the order to cancel when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"churnTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is reached."},"children":[]}]}]}],"completed":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Marks an order cancellation as completed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a read-only status that is set when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"churnTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is reached."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cancellation may not be changed or deleted when the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"revoked":"Revokes an order cancellation."}},"canceledTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when an order is canceled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, this occurs when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified."},"children":[]}]}]}],"type":["string","null"],"format":"date-time","readOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"churnTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the order is deactivated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"churnTimePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted, this value defaults to the current time."},"children":[]}]}]}],"type":"string","format":"date-time"},"churnTimePolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when the order is to be deactivated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"churnTimePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes precedence over the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"churnTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request."},"children":[]}]}]}],"type":["string","null"],"enum":[null,"now","at-next-renewal"]},"lineItems":{"description":"Items to be added to the new invoice.\nProration item is generated and added automatically.","type":"array","items":{"type":"object","description":"Invoice line item.","required":["type","unitPriceAmount","unitPriceCurrency","quantity"],"properties":{"type":{"description":"Type of invoice line item.","type":"string","enum":["debit","credit"]},"description":{"description":"Description of the line item.","type":"string","maxLength":1000},"unitPriceAmount":{"description":"Unit price of the line item.","type":"number","format":"double","example":49.95},"unitPriceCurrency":{"$ref":"#/components/schemas/CurrencyCode"},"quantity":{"description":"Quantity of the line item.","type":"integer","example":1},"periodStartTime":{"description":"Date and time when the service period begins for this item.","type":"string","format":"date-time"},"periodEndTime":{"description":"Date and time when the service period ends for this item.","type":"string","format":"date-time"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"}}}},"lineItemSubtotal":{"description":"Subtotal of the line items added after the order cancellation.","readOnly":true,"type":"object","properties":{"amount":{"type":"number","description":"Subtotal amount of the line items.","example":49.95},"currency":{"$ref":"#/components/schemas/CurrencyCode"}}},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/OrderReactivation":{"id":"components/schemas/OrderReactivation","kind":"json-schema","title":"OrderReactivation","data":{"type":"object","required":["orderId"],"properties":{"id":{"type":"string","description":"ID of the reactivation.","readOnly":true,"maxLength":50,"example":"ord_rct_0YVJ62AF5XCFCA6EBFAAA3Z7E0"},"orderId":{"type":"string","description":"ID of the reactivated order.","maxLength":50,"example":"ord_01HRF27SATGE4Z6PBJE6PD8328"},"cancellationId":{"type":"string","description":"ID of the related cancellation.","readOnly":true,"maxLength":50,"example":"sub_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV"},"description":{"description":"Description of the reactivation reason in free form.","type":["string","null"],"maxLength":255},"effectiveTime":{"description":"Date and time when the service period starts,\nunless the order is canceled but still active.\n\nIf the order is still active,\nthe order continues for the current service period.\n\nIf this field is omitted, this value defaults to the current time.","type":"string","format":"date-time","writeOnly":true},"renewalTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time of the next order renewal."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is omitted, this value is computed from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the order is canceled but still active,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it is ignored and the next renewal occurs as scheduled."},"children":[]}]}]}],"type":"string","format":"date-time"},"paymentInstrumentId":{"writeOnly":true,"description":"ID of the payment instrument.\nIf this field is omitted, the order payment instrument remains unchanged.","type":["string","null"],"maxLength":50,"example":"4f6cf35x-2c4y-483z-a0a9-158621f77a21"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/SubscriptionChange":{"id":"components/schemas/SubscriptionChange","kind":"json-schema","title":"SubscriptionChange","data":{"type":"object","required":["items","renewalPolicy","prorated"],"properties":{"items":{"description":"Details of items in the order.","type":"array","minItems":1,"items":{"type":"object","description":"New set of items for the subscription.\nTo remove an item, include the items array and exclude the items you want to remove.","required":["plan"],"properties":{"plan":{"description":"Plan details.","oneOf":[{"$ref":"#/components/schemas/OriginalPlan"},{"$ref":"#/components/schemas/FlexiblePlan"}]},"quantity":{"description":"Number of units of the product on the given plan.","type":"integer"},"usageLimits":{"$ref":"#/components/schemas/UsageLimits"}}}},"renewalPolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the service periods and trial state of the subscription order are managed when its items change."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values are deprecated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deprecated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keepTrial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ignoreRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are ignored unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used."},"children":[]}]}]}],"type":"string","enum":["resetToRecurring","retainRecurring","retainTrialThenRecurring","retainTrialOnly","reset","retain"],"x-enumDescriptions":{"resetToRecurring":"Resets the service periods, ends any trial, and converts trial-only items to recurring.","retainRecurring":"Retains the current service periods, ends any trial, and converts trial-only items to recurring.","retainTrialThenRecurring":"Retains the trial until it ends, then converts the item to recurring.\nReturns a validation error if the order has no trial.","retainTrialOnly":"Retains the trial and keeps the item as trial-only.\nReturns a validation error if the order is not trial-only.","reset":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resetToRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resets the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to a newly calculated value."},"children":[]}]}]}],"retain":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialThenRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialOnly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retains the current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"prorated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to give a pro rata credit for the amount of time remaining between the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the end of the current period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In addition, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is retained, by setting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialThenRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialOnly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a pro rata debit occurs for the amount between the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a percentage of the normal period size."},"children":[]}]}]}],"type":"boolean"},"effectiveTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date from which the renewal time for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations and proration calculations are made."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is omitted, this value defaults to the current time."},"children":[]}]}]}],"type":"string","format":"date-time"},"preview":{"description":"Specifies if changes to the subscription can be previewed.\nSubscriptions cannot be changed in preview.","type":"boolean","default":false},"keepTrial":{"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialThenRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialOnly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the order must retain its active trial."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to the deprecated value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"ignoreRecurring":{"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialOnly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the order must ignore the recurring settings of its items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only applicable if the order is trial-only and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keepTrial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/subscriptions#trial-only-subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trial-only order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false}}}},"components/schemas/OrderChange":{"id":"components/schemas/OrderChange","kind":"json-schema","title":"OrderChange","data":{"type":"object","required":["items","renewalPolicy","prorated"],"properties":{"items":{"description":"Details of items in the order.","type":"array","minItems":1,"items":{"type":"object","description":"New items for the order.\nTo remove an item, include the items array and exclude the items you want to remove.","required":["plan"],"properties":{"plan":{"description":"Plan details.","oneOf":[{"$ref":"#/components/schemas/OriginalPlan"},{"$ref":"#/components/schemas/FlexiblePlan"}]},"quantity":{"description":"Number of units of the product on the given plan.","type":"integer"},"usageLimits":{"$ref":"#/components/schemas/UsageLimits"}}}},"renewalPolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the service periods and trial state of the subscription order are managed when its items change."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values are deprecated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deprecated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keepTrial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ignoreRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are ignored unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used."},"children":[]}]}]}],"type":"string","enum":["resetToRecurring","retainRecurring","retainTrialThenRecurring","retainTrialOnly","reset","retain"],"x-enumDescriptions":{"resetToRecurring":"Resets the service periods, ends any trial, and converts trial-only items to recurring.","retainRecurring":"Retains the current service periods, ends any trial, and converts trial-only items to recurring.","retainTrialThenRecurring":"Retains the trial until it ends, then converts the item to recurring.\nReturns a validation error if the order has no trial.","retainTrialOnly":"Retains the trial and keeps the item as trial-only.\nReturns a validation error if the order is not trial-only.","reset":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resetToRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resets the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to a newly calculated value."},"children":[]}]}]}],"retain":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialThenRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialOnly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retains the current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"prorated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to give a pro rata credit for the amount of time remaining between the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the end of the current period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In addition, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is retained, by setting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialThenRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialOnly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a pro rata debit occurs for the amount between the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a percentage of the normal period size."},"children":[]}]}]}],"type":"boolean"},"effectiveTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date from which the renewal time for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations and proration calculations are made."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is omitted, this value defaults to the current time."},"children":[]}]}]}],"type":"string","format":"date-time"},"preview":{"description":"Specifies if changes to the order can be previewed.\nOrders cannot be changed in preview.","type":"boolean","default":false},"keepTrial":{"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialThenRecurring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialOnly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the order must retain its active trial."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to the deprecated value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false},"ignoreRecurring":{"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retainTrialOnly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"renewalPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the order must ignore the recurring settings of its items."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is only applicable if the order is trial-only and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keepTrial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/subscriptions#trial-only-subscription"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trial-only order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"boolean","default":false}}}},"components/schemas/OrderItemUpdate":{"id":"components/schemas/OrderItemUpdate","kind":"json-schema","title":"OrderItemUpdate","data":{"type":"object","properties":{"quantityFilled":{"description":"Filled quantity of the subscription item (experimental property).","type":"number","format":"double","example":5.125},"excludeFromMrr":{"type":"boolean","description":"Specifies if this item should be excluded from monthly recurring revenue calculations."},"plan":{"type":"object","description":"Details of the subscription item plan.","properties":{"productOptions":{"type":["object","null"],"description":"Name-value pairs that specify the product options.","additionalProperties":{"type":"string"},"example":{"color":"red","size":"xxl"}}}}}}},"components/schemas/SubscriptionInvoice":{"id":"components/schemas/SubscriptionInvoice","kind":"json-schema","title":"SubscriptionInvoice","data":{"type":"object","properties":{"transactionId":{"description":"If present, applies a payment to the invoice created.\nIf the payment is for the invoice total, it would be marked as paid.","$ref":"#/components/schemas/TransactionId"}}}},"components/schemas/SubscriptionPause":{"id":"components/schemas/SubscriptionPause","kind":"json-schema","title":"SubscriptionPause","data":{"type":"object","description":"Subscription pause details.","required":["subscriptionId"],"properties":{"id":{"type":"string","description":"ID of the subscription pause.","readOnly":true,"maxLength":50,"example":"sub_pau_01H085J3ZR1WKD120D73D7N4C9"},"subscriptionId":{"type":"string","description":"ID of the paused subscription.","maxLength":50,"example":"sub_01HRF27SATGE4Z6PBJE6PD8328"},"status":{"description":"Status of the subscription pause.","type":"string","readOnly":true,"enum":["pending","ongoing","revoked","finished"]},"pausedBy":{"description":"Specifies who initiated the pause.","type":"string","default":"customer","enum":["merchant","customer"]},"description":{"description":"Description of the pause reason in free form.","type":["string","null"],"maxLength":255},"effectiveTime":{"description":"Date and time when the service period pauses.\n\nThis time must be later than the current time.\nIf this time is earlier then the current time, the current time is used.\n\nIf this field is omitted, this value defaults to the current time.","type":["string","null"],"format":"date-time"},"endTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the pause ends and the subscription resumes billing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To resume a subscription from this point in time,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"use the current time or an earlier time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is earlier then the current time, the current time is used."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is empty, the subscription is indefinitely paused."},"children":[]}]}]}],"type":["string","null"],"format":"date-time"},"timeRemaining":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of time between the pause end time and the renewal time in ISO-8601 durations format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, this value is computed as the time between the pause and the renewal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: A $30 per month subscription on a 30-day month is paused on day 20 of the subscription."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are 10 unused days on the subscription."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Therefore, the subscription renews in 10 days after it is resumed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The upcoming invoice does not change the amount for the invoiced period, it remains at $30."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the subscription uses a billing anchor,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the renewal time after a pause shift behaves as though the renewal time is moved forward by an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order API operation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the billing anchor is ignored for that period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service period anchor, billing timing, and invoice time shift"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"example":"P3600S"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/SubscriptionCancellation":{"id":"components/schemas/SubscriptionCancellation","kind":"json-schema","title":"SubscriptionCancellation","data":{"type":"object","required":["subscriptionId"],"properties":{"id":{"type":"string","description":"ID of the cancellation.","readOnly":true,"maxLength":50,"example":"sub_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV"},"subscriptionId":{"type":"string","description":"ID of the canceled subscription order.","maxLength":50,"example":"sub_01HRF27SATGE4Z6PBJE6PD8328"},"proratedInvoiceId":{"type":["string","null"],"description":"ID of the invoice on which the cancellation proration is calculated.","readOnly":true,"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"appliedInvoiceId":{"type":["string","null"],"description":"ID of the invoice on which the cancellation fees or credits are applied.","readOnly":true,"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"canceledBy":{"description":"Specifies who initiated the cancellation.","type":"string","default":"customer","enum":["merchant","customer","rebilly"]},"reason":{"description":"Reason for the cancellation.","type":"string","default":"other","enum":["did-not-use","did-not-want","missing-features","bugs-or-problems","do-not-remember","risk-warning","contract-expired","too-expensive","other","billing-failure"]},"description":{"description":"Description of the cancellation reason in free form.","type":"string","maxLength":255},"prorated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the customer gets a pro-rata credit for the time remaining between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"churnTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and subscription next renewal time."},"children":[]}]}]}],"type":"boolean","default":false},"status":{"description":"Status of the subscription order.","type":"string","default":"confirmed","enum":["draft","confirmed","completed","revoked"],"x-enumDescriptions":{"draft":"Creates a draft cancellation so that the cancellation and charge can be previewed.","confirmed":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirms a subscription cancellation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the subscription to cancel when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"churnTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is reached."},"children":[]}]}]}],"completed":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Marks a subscription cancellation as completed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a read-only status that is set when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"churnTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is reached."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cancellation may not be changed or deleted when the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"revoked":"Revokes a subscription cancellation."}},"canceledTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when a subscription is canceled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, this occurs when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified."},"children":[]}]}]}],"type":["string","null"],"format":"date-time","readOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"churnTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the subscription is deactivated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"churnTimePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted, this value defaults to the current time."},"children":[]}]}]}],"type":"string","format":"date-time"},"churnTimePolicy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies when the subscription is to be deactivated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"churnTimePolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes precedence over the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"churnTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request."},"children":[]}]}]}],"type":["string","null"],"enum":["null","now","at-next-renewal"]},"lineItems":{"description":"Items to be added to the new invoice.\nProration item is generated and added automatically.","type":"array","items":{"type":"object","description":"Invoice line item.","required":["type","unitPriceAmount","unitPriceCurrency","quantity"],"properties":{"type":{"description":"Type of invoice line item.","type":"string","enum":["debit","credit"]},"description":{"description":"Description of the line item.","type":"string","maxLength":1000},"unitPriceAmount":{"description":"Unit price of the line item.","type":"number","format":"double","example":49.95},"unitPriceCurrency":{"$ref":"#/components/schemas/CurrencyCode"},"quantity":{"description":"Quantity of the line item.","type":"integer","example":1},"periodStartTime":{"description":"Date and time when the period begins for this item.","type":"string","format":"date-time"},"periodEndTime":{"description":"Date and time when the period ends for this item.","type":"string","format":"date-time"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"}}}},"lineItemSubtotal":{"description":"Subtotal of the line items added after the subscription cancellation.","readOnly":true,"type":"object","properties":{"amount":{"type":"number","description":"Subtotal amount of the line items.","example":49.95},"currency":{"$ref":"#/components/schemas/CurrencyCode"}}},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/SubscriptionReactivation":{"id":"components/schemas/SubscriptionReactivation","kind":"json-schema","title":"SubscriptionReactivation","data":{"type":"object","required":["subscriptionId"],"properties":{"id":{"type":"string","description":"ID of the reactivation.","readOnly":true,"maxLength":50,"example":"sub_rct_0YVJ62AF5XCFCA6EBFAAA3Z7E0"},"subscriptionId":{"type":"string","description":"ID of the reactivated subscription.","maxLength":50,"example":"sub_01HRF27SATGE4Z6PBJE6PD8328"},"cancellationId":{"type":"string","description":"ID of the related cancellation.","readOnly":true,"maxLength":50,"example":"sub_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV"},"description":{"description":"Description of the reactivation reason in free form.","type":["string","null"],"maxLength":255},"effectiveTime":{"description":"Date and time when the service period starts,\nunless the subscription is canceled but still active.\n\nIf the subscription is still active,\nthe subscription continues for the current service period.\n\nIf this field is omitted, this value defaults to the current time.","type":"string","format":"date-time","writeOnly":true},"renewalTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time of the next subscription renewal."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is omitted, this value is computed from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effectiveTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the subscription is canceled but still active,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it is ignored and the next renewal occurs as scheduled."},"children":[]}]}]}],"type":"string","format":"date-time"},"paymentInstrumentId":{"writeOnly":true,"description":"ID of the payment instrument.\nIf this field is omitted, the subscription payment instrument remains unchanged.","type":["string","null"],"maxLength":50,"example":"4f6cf35x-2c4y-483z-a0a9-158621f77a21"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/UpcomingInvoiceItem":{"id":"components/schemas/UpcomingInvoiceItem","kind":"json-schema","title":"UpcomingInvoiceItem","data":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","description":"ID of the upcoming invoice item.","maxLength":50,"example":"ii_0YVFDEQS2KCFTBN9HXWJFY55GV"},"isInterim":{"description":"Specifies if the line item is added to an interim invoice.","type":"boolean"},"description":{"description":"Description of the upcoming invoice item.","type":"string","maxLength":1000},"unitPrice":{"description":"Unit price of the upcoming invoice item.","type":"number","format":"double"},"quantity":{"description":"Quantity of the upcoming invoice item.","type":"integer"},"price":{"description":"Total price of the upcoming invoice item.","type":"number","format":"double"},"productId":{"type":["string","null"],"description":"ID of the product.","maxLength":50,"example":"prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"},"planId":{"type":["string","null"],"description":"ID of the plan.","maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"},"subscriptionId":{"type":"string","description":"ID of the order.","maxLength":50,"example":"sub_01HRF27SATGE4Z6PBJE6PD8328"},"periodStartTime":{"description":"Date and time when the billing period starts.","type":"string","format":"date-time"},"periodEndTime":{"description":"Date and time when the billing period ends.","type":"string","format":"date-time"},"periodNumber":{"description":"Billing period number that is associated with the invoice item.\nFor example, an invoice item for a service is included in billing period number 3.\nThe invoice item is only applied to billing period number 3.","type":"integer"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"tax":{"description":"Invoice item tax.","$ref":"#/components/schemas/TaxItem"},"_links":{"type":"array","description":"Related links.","items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","product","plan","subscription"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"properties":{"product":{"type":"object"},"plan":{"type":"object"}}}}}},"components/schemas/UpcomingInvoice":{"id":"components/schemas/UpcomingInvoice","kind":"json-schema","title":"UpcomingInvoice","data":{"type":"object","readOnly":true,"properties":{"id":{"description":"ID of the upcoming invoice, which is persisted in the future renewal invoice.","type":"string","readOnly":true,"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"websiteId":{"$ref":"#/components/schemas/WebsiteId"},"subscriptionId":{"description":"ID of the related subscription order.","type":"string","readOnly":true,"maxLength":50,"example":"sub_01HRF27SATGE4Z6PBJE6PD8328"},"currency":{"x-sortable":true,"x-basic":true,"$ref":"#/components/schemas/CurrencyCode"},"customerId":{"x-basic":true,"allOf":[{"$ref":"#/components/schemas/CustomerId"}]},"revision":{"description":"Number of times the upcoming invoice data has changed.\n\nUse the revision number when analyzing webhook data to\ndetermine if a change should take precedence over the current\nrepresentation.","type":"integer"},"organizationId":{"allOf":[{"$ref":"#/components/schemas/OrganizationId"}]},"items":{"type":"array","description":"Upcoming invoice items array.","items":{"$ref":"#/components/schemas/UpcomingInvoiceItem"}},"amount":{"description":"Amount of the invoice.","type":"number","x-type":"Money","x-sortable":true,"x-basic":true,"format":"double","readOnly":true},"amountDue":{"description":"Amount that is due on the invoice.","type":"number","x-type":"Money","x-sortable":true,"format":"double","readOnly":true},"subtotalAmount":{"description":"Subtotal amount of the invoice.","type":"number","x-type":"Money","format":"double","readOnly":true},"discountAmount":{"description":"Discount amount that is applied to the invoice.","type":"number","x-type":"Money","format":"double","readOnly":true},"shipping":{"$ref":"#/components/schemas/Shipping"},"tax":{"$ref":"#/components/schemas/Taxes"},"billingAddress":{"description":"Billing address of the invoice.","$ref":"#/components/schemas/ContactObject"},"deliveryAddress":{"description":"Delivery address of the invoice.","$ref":"#/components/schemas/ContactObject"},"poNumber":{"description":"Purchase order number that is displayed on the invoice.","type":["string","null"],"example":"PO123456"},"notes":{"description":"Notes for the customer that are displayed on the invoice.","type":"string"},"discounts":{"type":"array","description":"Discounts applied.","readOnly":true,"items":{"type":"object","readOnly":true,"properties":{"couponId":{"type":"string","description":"ID of the coupon.","maxLength":50,"example":"cpn_0YVCNKF81GD778N4YNVGDJK558"},"redemptionId":{"description":"ID of the redemption.","$ref":"#/components/schemas/ResourceId"},"amount":{"description":"Total amount discounted by this coupon.","type":"number","format":"double"},"description":{"type":"string","description":"Description of the discount."},"context":{"$ref":"#/components/schemas/DiscountContext"}}}},"isNewOrder":{"description":"Specifies if the order is a new order.","type":"boolean","readOnly":true,"example":true},"dueTime":{"description":"Date and time when the invoice is due for payment.","type":"string","x-sortable":true,"format":"date-time"},"issuedTime":{"description":"Date and time when the invoice is issued.","x-label":"Date Issued","x-sortable":true,"x-basic":true,"$ref":"#/components/schemas/ServerTimestamp"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related links.","items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","website","customer","organization","subscription","attachments","leadSource"]}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"properties":{"customer":{"type":"object"},"website":{"type":"object"},"organization":{"type":"object"},"leadSource":{"type":"object"}}}}}},"components/schemas/OrderTimeline":{"id":"components/schemas/OrderTimeline","kind":"json-schema","title":"OrderTimeline","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the timeline message.","readOnly":true,"maxLength":50,"example":"tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC"},"type":{"description":"Type of timeline message.","type":"string","readOnly":true,"enum":["coupon-applied","email-message-sent","invoice-abandoned","invoice-disputed","invoice-issued","invoice-paid","invoice-partially-paid","invoice-partially-refunded","invoice-past-due","invoice-refunded","invoice-reissued","invoice-renewal-payment-declined","invoice-voided","order-activated","order-autopay-changed","order-billing-address-changed","order-billing-anchor-changed","order-canceled","order-churned","order-completed","order-custom-fields-changed","order-delivery-address-changed","order-downgraded","order-items-changed","order-paid-early","order-quantity-changed","order-reactivated","order-recurring-interval-changed","order-renewal-time-changed","order-renewed","order-risk-metadata-changed","order-trial-ended","order-upgraded","order-voided","order-abandoned","quote-accepted","subscription-paused","subscription-pause-created","subscription-pause-modified","subscription-pause-revoked","subscription-resumed","subscription-trial-end-changed","timeline-comment-created"]},"triggeredBy":{"description":"Specifies who, or what, triggered the timeline event.","type":"string","readOnly":true,"enum":["rebilly","app","direct-api"]},"message":{"description":"Contents of the timeline message.","type":"string"},"extraData":{"$ref":"#/components/schemas/TimelineExtraData"},"occurredTime":{"description":"Date and time when the timeline message occurred.","readOnly":true,"$ref":"#/components/schemas/ServerTimestamp"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/Usage":{"id":"components/schemas/Usage","kind":"json-schema","title":"Usage","data":{"type":"object","required":["subscriptionId","quantity"],"properties":{"id":{"type":"string","readOnly":true,"description":"ID of the usage record.","maxLength":50,"example":"sub_usg_0YVJ636B95DNA9M3B1638HXBCQ"},"subscriptionId":{"type":"string","description":"Subscription ID for which the usage is reported.","maxLength":50,"example":"sub_01HRF27SATGE4Z6PBJE6PD8328"},"invoiceId":{"type":["string","null"],"description":"ID of the invoice to which usage is applied.\nThis value is populated when the invoice is issued.","readOnly":true,"maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"invoiceItemId":{"description":"ID of the invoice item to which usage is applied.\nThis value is populated when the invoice is issued.","readOnly":true,"type":["string","null"],"maxLength":50,"example":"ii_0YVFDEQS2KCFTBN9HXWJFY55GV"},"quantity":{"description":"Quantity of consumed units for a subscription plan product.\nRepresents the actual usage of a billable product or service by the customer.\nAccepts both integer and decimal values with a precision of up to 3 decimal places.\nThe minimum billable unit is 0.001.","type":"number","format":"double","minimum":0.001,"example":5.125},"usageTime":{"description":"Date and time, in ISO 8601 format, when a usage occurred.\nIf this value is not provided or is empty, the date and time of the request is used.","type":"string","format":"date-time"},"acceptPartialQuantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether partial usage should be accepted if the reported quantity exceeds the available limit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system automatically adjusts the reported quantity to the maximum allowed limit and reports the usage."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system rejects the request if the reported quantity exceeds the limit."},"children":[]}]}]}],"type":"boolean","writeOnly":true,"default":false,"example":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/PaymentCardToken":{"id":"components/schemas/PaymentCardToken","kind":"json-schema","title":"Payment card token","data":{"type":"object","title":"Payment card token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a payment card token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment card token is a string that represents a customer's payment card details."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It can be used once, and expires upon first use or within 30 minutes of token creation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To generate a full payment card token, you must provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided, the token can not be used for payments."},"children":[]}]}]}],"required":["method","paymentInstrument"],"properties":{"method":{"description":"Payment method of the token.","type":"string","enum":["payment-card"]},"paymentInstrument":{"description":"Payment card instrument details.","type":"object","required":["expMonth","expYear"],"properties":{"pan":{"description":"Primary Account Number (PAN) of the payment card.\nThis value is required to perform a payment.","type":"string","writeOnly":true},"cvv":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Verification Value (CVV/CVC) of the payment card."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"encryptedCvv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if both are included."},"children":[]}]}]}],"type":"string","writeOnly":true},"encryptedCvv":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encrypted CVV of the payment card."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use to update a payment card with a CVV stored on the client side."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is returned for client side caching if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cvv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided in the request."},"children":[]}]}]}],"type":["string","null"],"minLength":100,"maxLength":255},"expMonth":{"description":"Expiration month of the payment card.","type":"integer"},"expYear":{"description":"Expiration year of the payment card.","type":"integer"},"bin":{"description":"Bank Identification Number (BIN) of the payment card.\nThis value is the first 6 digits of the payment card number.","type":["string","null"],"format":"bin","readOnly":true},"last4":{"description":"Last 4 digits of the Primary Account Number (PAN) of the payment card.","type":["string","null"],"readOnly":true},"brand":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/PaymentCardBrand"}]}}},"billingAddress":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing address object."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is required to perform payments."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For payment-card updates, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be ignored."},"children":[]}]}]}],"$ref":"#/components/schemas/ContactObject"},"id":{"description":"ID of the token.","readOnly":true,"$ref":"#/components/schemas/ResourceId"},"isUsed":{"description":"Specifies if the token has been used.","type":"boolean","default":false,"readOnly":true},"riskMetadata":{"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"leadSource":{"allOf":[{"$ref":"#/components/schemas/LeadSource"}],"writeOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"usageTime":{"description":"Date and time when the token is used.","type":["string","null"],"format":"date-time","readOnly":true},"expirationTime":{"description":"Date and time when the token expired.","type":["string","null"],"format":"date-time","readOnly":true},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/PayPalToken":{"id":"components/schemas/PayPalToken","kind":"json-schema","title":"PayPal token","data":{"type":"object","title":"PayPal token","required":["method","paymentInstrument"],"properties":{"method":{"description":"Payment method of the token.","type":"string","enum":["paypal"]},"paymentInstrument":{"description":"Paypal instrument details required for express checkout.","type":"object","required":["billingAgreementToken","paypalMerchantId"],"properties":{"paypalMerchantId":{"description":"ID of the PayPal merchant.","type":"string"},"billingAgreementToken":{"description":"PayPal billing agreement token.","type":"string"}}},"billingAddress":{"description":"Billing address object.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"id":{"description":"ID of the token.","readOnly":true,"$ref":"#/components/schemas/ResourceId"},"isUsed":{"description":"Specifies if the token is already used.","type":"boolean","default":false,"readOnly":true},"riskMetadata":{"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"leadSource":{"allOf":[{"$ref":"#/components/schemas/LeadSource"}],"writeOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"usageTime":{"description":"Date and time when the token is used.","type":["string","null"],"format":"date-time","readOnly":true},"expirationTime":{"description":"Date and time when the token expires.","type":["string","null"],"format":"date-time","readOnly":true},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/BBANInstrument":{"id":"components/schemas/BBANInstrument","kind":"json-schema","title":"BBANInstrument","data":{"description":"Bank account BBAN instrument.","type":"object","required":["accountNumberType","accountNumber","routingNumber","accountType"],"properties":{"accountNumberType":{"description":"Bank account number type.\nA valid value is basic bank account number (BBAN) or international bank account number (IBAN).","type":"string","enum":["BBAN"]},"accountNumber":{"description":"Customer's bank account number.","type":"string","pattern":"^[0-9]+$","writeOnly":true},"routingNumber":{"description":"Bank routing number.","type":"string","pattern":"^[0-9]+$"},"accountType":{"description":"Bank account type.","type":"string","enum":["checking","savings","other"]},"bic":{"description":"Bank Identifier Code (BIC).","type":"string"},"bankName":{"description":"Bank name.","type":"string"},"last4":{"description":"Last 4 digits of the bank account number.","type":"string","readOnly":true}}}},"components/schemas/IBANInstrument":{"id":"components/schemas/IBANInstrument","kind":"json-schema","title":"IBANInstrument","data":{"description":"Bank account IBAN instrument.","type":"object","required":["accountNumberType","accountNumber"],"properties":{"accountNumberType":{"description":"Bank account number type.\nA valid value is basic bank account number (BBAN) or international bank account number (IBAN).","type":"string","enum":["IBAN"]},"accountNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detailed information about all ISO 13616-compliant national IBAN formats is available in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.swift.com/standards/data-standards/iban"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SWIFT IBAN Registry"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","writeOnly":true},"bic":{"description":"Bank Identifier Code (BIC).","type":"string"},"bankName":{"description":"Bank name.","type":"string"},"last4":{"description":"Last 4 digits of the bank account number.","type":"string","readOnly":true}}}},"components/schemas/BankAccountInstrument":{"id":"components/schemas/BankAccountInstrument","kind":"json-schema","title":"BankAccountInstrument","data":{"type":"object","description":"Bank account BBAN or IBAN instrument.","discriminator":{"propertyName":"accountNumberType","mapping":{"BBAN":"#/components/schemas/BBANInstrument","IBAN":"#/components/schemas/IBANInstrument"}},"oneOf":[{"$ref":"#/components/schemas/BBANInstrument"},{"$ref":"#/components/schemas/IBANInstrument"}]}},"components/schemas/BankAccountToken":{"id":"components/schemas/BankAccountToken","kind":"json-schema","title":"Bank account token","data":{"type":"object","title":"Bank account token","required":["method","paymentInstrument","billingAddress"],"properties":{"method":{"description":"Payment method of the token.","type":"string","enum":["ach","echeck"]},"paymentInstrument":{"$ref":"#/components/schemas/BankAccountInstrument"},"billingAddress":{"description":"Billing address object.","$ref":"#/components/schemas/ContactObject"},"id":{"description":"ID of the token.","readOnly":true,"$ref":"#/components/schemas/ResourceId"},"isUsed":{"description":"Specifies if the token is already used.","type":"boolean","default":false,"readOnly":true},"riskMetadata":{"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"leadSource":{"allOf":[{"$ref":"#/components/schemas/LeadSource"}],"writeOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"usageTime":{"description":"Date and time when the token is used.","type":["string","null"],"format":"date-time","readOnly":true},"expirationTime":{"description":"Date and time when the token expired.","type":["string","null"],"format":"date-time","readOnly":true},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/DigitalWalletToken":{"id":"components/schemas/DigitalWalletToken","kind":"json-schema","title":"Digital wallet token","data":{"type":"object","title":"Digital wallet token","required":["method","paymentInstrument"],"properties":{"method":{"description":"Payment method of the token.","type":"string","enum":["digital-wallet"]},"paymentInstrument":{"description":"Payment instrument details.","type":"object","required":["type","amount","currency","descriptor","payload"],"properties":{"type":{"description":"Type of digital wallet.","type":"string","enum":["Apple Pay","Google Pay","Samsung Pay"]},"amount":{"description":"Authorized for the digital wallet amount.","type":"number","format":"double"},"currency":{"description":"Authorized for the digital wallet currency.","$ref":"#/components/schemas/CurrencyCode"},"descriptor":{"description":"Descriptor for a payment.","type":"string"},"bin":{"description":"Bank Identification Number (BIN) of the payment card.\nThis value is the same as the first 6 digits of the associated Device Primary Account Number (DPAN).","type":["string","null"],"format":"bin","readOnly":true},"last4":{"description":"Last 4 digits of the Device Primary Account Number (DPAN) of the payment card.\nThe DPAN is the tokenized card number used in digital wallet transactions,\nas opposed to the Funding Primary Account Number (FPAN) which is the physical card number visible to the cardholder.","type":"string","readOnly":true},"fpanLast4":{"description":"Last 4 digits of the Funding Primary Account Number (FPAN) of the payment card.\nThe FPAN is the physical card number visible to the cardholder,\nas opposed to the Device Primary Account Number (DPAN) used in digital wallet transactions.","type":["string","null"],"readOnly":true},"brand":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/PaymentCardBrand"}]},"expMonth":{"readOnly":true,"description":"Payment card expiration month.","type":"integer"},"expYear":{"readOnly":true,"description":"Payment card expiration year.","type":"integer"},"payload":{"writeOnly":true,"description":"Digital wallet encoded data.\nThis field may contain the digital wallet billing address.","type":"object"}}},"billingAddress":{"readOnly":true,"description":"Billing address object.","$ref":"#/components/schemas/ContactObject"},"id":{"description":"ID of the token.","readOnly":true,"$ref":"#/components/schemas/ResourceId"},"isUsed":{"description":"Specifies if the token is already used.","type":"boolean","default":false,"readOnly":true},"riskMetadata":{"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"leadSource":{"allOf":[{"$ref":"#/components/schemas/LeadSource"}],"writeOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"usageTime":{"description":"Date and time when the token is used.","type":["string","null"],"format":"date-time","readOnly":true},"expirationTime":{"description":"Date and time when the token expired.","type":["string","null"],"format":"date-time","readOnly":true},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/PlaidAccountToken":{"id":"components/schemas/PlaidAccountToken","kind":"json-schema","title":"Plaid account token","data":{"type":"object","title":"Plaid account token","required":["method","billingAddress","paymentInstrument"],"properties":{"method":{"description":"Payment method of the token.","type":"string","enum":["plaid-account"]},"paymentInstrument":{"description":"Plaid payment instrument details.","type":"object","required":["linkToken","publicToken","accountId"],"properties":{"linkToken":{"type":"string","description":"Plaid link token.","writeOnly":true},"publicToken":{"type":"string","description":"Plaid public token."},"accountId":{"type":"string","description":"ID of the Plaid account."}}},"billingAddress":{"description":"Billing address object.","$ref":"#/components/schemas/ContactObject"},"id":{"description":"ID of the token.","readOnly":true,"$ref":"#/components/schemas/ResourceId"},"isUsed":{"description":"Specifies if the token is already used.","type":"boolean","default":false,"readOnly":true},"riskMetadata":{"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"leadSource":{"allOf":[{"$ref":"#/components/schemas/LeadSource"}],"writeOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"usageTime":{"description":"Date and time when the token is used.","type":["string","null"],"format":"date-time","readOnly":true},"expirationTime":{"description":"Date and time when the token expired.","type":["string","null"],"format":"date-time","readOnly":true},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/KhelocardCardToken":{"id":"components/schemas/KhelocardCardToken","kind":"json-schema","title":"Khelocard card token","data":{"type":"object","title":"Khelocard card token","required":["method","billingAddress","paymentInstrument"],"properties":{"method":{"description":"Payment method of the token.","type":"string","enum":["Khelocard"]},"paymentInstrument":{"description":"Token instrument details.","type":"object","required":["number","cvv","expYear","expMonth"],"properties":{"number":{"description":"Khelocard card number.","type":"string","writeOnly":true},"cvv":{"description":"Khelocard Card Verification Value (CVV).","type":"string","writeOnly":true},"last4":{"description":"Last 4 digits of the Khelocard card number.","type":"string","readOnly":true},"expMonth":{"description":"Khelocard card expiration month.","type":"integer"},"expYear":{"description":"Khelocard card expiration year.","type":"integer"}}},"billingAddress":{"description":"Billing address object.","$ref":"#/components/schemas/ContactObject"},"id":{"description":"ID of the token.","readOnly":true,"$ref":"#/components/schemas/ResourceId"},"isUsed":{"description":"Specifies if the token is already used.","type":"boolean","default":false,"readOnly":true},"riskMetadata":{"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"leadSource":{"allOf":[{"$ref":"#/components/schemas/LeadSource"}],"writeOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"usageTime":{"description":"Date and time when the token is used.","type":["string","null"],"format":"date-time","readOnly":true},"expirationTime":{"description":"Date and time when the token expired.","type":["string","null"],"format":"date-time","readOnly":true},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/KlarnaToken":{"id":"components/schemas/KlarnaToken","kind":"json-schema","title":"Klarna token","data":{"type":"object","title":"Klarna token","required":["method","paymentInstrument"],"properties":{"method":{"description":"Payment method of the token.","type":"string","enum":["Klarna"]},"paymentInstrument":{"description":"Klarna instrument details required for express checkout.","type":"object","required":["klarnaAuthorizationToken","klarnaSessionId"],"properties":{"klarnaAuthorizationToken":{"description":"Klarna authorization token.","type":"string"},"klarnaSessionId":{"description":"ID of the Klarna session.","type":"string"}}},"billingAddress":{"description":"Billing address object.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"id":{"description":"ID of the token.","readOnly":true,"$ref":"#/components/schemas/ResourceId"},"isUsed":{"description":"Specifies if the token is already used.","type":"boolean","default":false,"readOnly":true},"riskMetadata":{"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"leadSource":{"allOf":[{"$ref":"#/components/schemas/LeadSource"}],"writeOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"usageTime":{"description":"Date and time when the token is used.","type":["string","null"],"format":"date-time","readOnly":true},"expirationTime":{"description":"Date and time when the token expired.","type":["string","null"],"format":"date-time","readOnly":true},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/AlternativePaymentToken":{"id":"components/schemas/AlternativePaymentToken","kind":"json-schema","title":"Alternative payment token","data":{"type":"object","title":"Alternative payment token","required":["method","billingAddress"],"properties":{"method":{"description":"Payment method of the token.","type":"string","allOf":[{"$ref":"#/components/schemas/AlternativePaymentMethods"},{"not":{"enum":["payment-card","paypal","ach","echeck","digital-wallet","plaid-account","Khelocard","Klarna","cryptocurrency"]}}]},"billingAddress":{"description":"Billing address object.","$ref":"#/components/schemas/ContactObject"},"id":{"description":"ID of the token.","readOnly":true,"$ref":"#/components/schemas/ResourceId"},"isUsed":{"description":"Specifies if the token is already used.","type":"boolean","default":false,"readOnly":true},"riskMetadata":{"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"leadSource":{"allOf":[{"$ref":"#/components/schemas/LeadSource"}],"writeOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"usageTime":{"description":"Date and time when the token is used.","type":["string","null"],"format":"date-time","readOnly":true},"expirationTime":{"description":"Date and time when the token expired.","type":["string","null"],"format":"date-time","readOnly":true},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/CryptocurrencyToken":{"id":"components/schemas/CryptocurrencyToken","kind":"json-schema","title":"Cryptocurrency token","data":{"type":"object","title":"Cryptocurrency token","required":["method"],"properties":{"method":{"description":"Payment method of the token.","type":"string","enum":["cryptocurrency"]},"walletName":{"description":"Name of the crypto wallet.","type":["string","null"],"maxLength":255},"walletAddress":{"description":"Address of the crypto wallet.","type":["string","null"],"maxLength":255},"walletCurrency":{"description":"Currency of the crypto wallet.","type":["string","null"],"maxLength":255},"walletNetwork":{"description":"Network of the crypto wallet.","type":["string","null"],"maxLength":255},"billingAddress":{"description":"Billing address object.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"id":{"description":"ID of the token.","readOnly":true,"$ref":"#/components/schemas/ResourceId"},"isUsed":{"description":"Specifies if the token is already used.","type":"boolean","default":false,"readOnly":true},"riskMetadata":{"oneOf":[{"$ref":"#/components/schemas/RiskMetadata"},{"type":"null"}]},"leadSource":{"allOf":[{"$ref":"#/components/schemas/LeadSource"}],"writeOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"usageTime":{"description":"Date and time when the token is used.","type":["string","null"],"format":"date-time","readOnly":true},"expirationTime":{"description":"Date and time when the token expired.","type":["string","null"],"format":"date-time","readOnly":true},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/CompositeToken":{"id":"components/schemas/CompositeToken","kind":"json-schema","title":"CompositeToken","data":{"type":"object","discriminator":{"propertyName":"method","mapping":{"payment-card":"#/components/schemas/PaymentCardToken","paypal":"#/components/schemas/PayPalToken","ach":"#/components/schemas/BankAccountToken","echeck":"#/components/schemas/BankAccountToken","digital-wallet":"#/components/schemas/DigitalWalletToken","plaid-account":"#/components/schemas/PlaidAccountToken","Khelocard":"#/components/schemas/KhelocardCardToken","Klarna":"#/components/schemas/KlarnaToken","cash":"#/components/schemas/AlternativePaymentToken","check":"#/components/schemas/AlternativePaymentToken","AdvCash":"#/components/schemas/AlternativePaymentToken","Alfa-click":"#/components/schemas/AlternativePaymentToken","Alipay":"#/components/schemas/AlternativePaymentToken","AstroPay Card":"#/components/schemas/AlternativePaymentToken","AstroPay-GO":"#/components/schemas/AlternativePaymentToken","BankReferenced":"#/components/schemas/AlternativePaymentToken","bank-transfer":"#/components/schemas/AlternativePaymentToken","bank-transfer-2":"#/components/schemas/AlternativePaymentToken","bank-transfer-3":"#/components/schemas/AlternativePaymentToken","bank-transfer-4":"#/components/schemas/AlternativePaymentToken","bank-transfer-5":"#/components/schemas/AlternativePaymentToken","bank-transfer-6":"#/components/schemas/AlternativePaymentToken","bank-transfer-7":"#/components/schemas/AlternativePaymentToken","bank-transfer-8":"#/components/schemas/AlternativePaymentToken","bank-transfer-9":"#/components/schemas/AlternativePaymentToken","Baloto":"#/components/schemas/AlternativePaymentToken","Beeline":"#/components/schemas/AlternativePaymentToken","Belfius-direct-net":"#/components/schemas/AlternativePaymentToken","bitcoin":"#/components/schemas/AlternativePaymentToken","Bizum":"#/components/schemas/AlternativePaymentToken","Boleto":"#/components/schemas/AlternativePaymentToken","cash-deposit":"#/components/schemas/AlternativePaymentToken","CASHlib":"#/components/schemas/AlternativePaymentToken","CashToCode":"#/components/schemas/AlternativePaymentToken","China UnionPay":"#/components/schemas/AlternativePaymentToken","Cleo":"#/components/schemas/AlternativePaymentToken","CODVoucher":"#/components/schemas/AlternativePaymentToken","Conekta-oxxo":"#/components/schemas/AlternativePaymentToken","Cupon-de-pagos":"#/components/schemas/AlternativePaymentToken","cryptocurrency":"#/components/schemas/CryptocurrencyToken","domestic-cards":"#/components/schemas/AlternativePaymentToken","ecoPayz":"#/components/schemas/AlternativePaymentToken","ecoVoucher":"#/components/schemas/AlternativePaymentToken","Efecty":"#/components/schemas/AlternativePaymentToken","EPS":"#/components/schemas/AlternativePaymentToken","ePay.bg":"#/components/schemas/AlternativePaymentToken","eZeeWallet":"#/components/schemas/AlternativePaymentToken","FasterPay":"#/components/schemas/AlternativePaymentToken","Flexepin":"#/components/schemas/AlternativePaymentToken","Giropay":"#/components/schemas/AlternativePaymentToken","Gpaysafe":"#/components/schemas/AlternativePaymentToken","Google Pay":"#/components/schemas/AlternativePaymentToken","iDebit":"#/components/schemas/AlternativePaymentToken","iDEAL":"#/components/schemas/AlternativePaymentToken","ING-homepay":"#/components/schemas/AlternativePaymentToken","INOVAPAY-pin":"#/components/schemas/AlternativePaymentToken","INOVAPAY-wallet":"#/components/schemas/AlternativePaymentToken","InstaDebit":"#/components/schemas/AlternativePaymentToken","instant-bank-transfer":"#/components/schemas/AlternativePaymentToken","InstantPayments":"#/components/schemas/AlternativePaymentToken","Interac":"#/components/schemas/AlternativePaymentToken","Interac-online":"#/components/schemas/AlternativePaymentToken","Interac-eTransfer":"#/components/schemas/AlternativePaymentToken","invoice":"#/components/schemas/AlternativePaymentToken","iWallet":"#/components/schemas/AlternativePaymentToken","Jeton":"#/components/schemas/AlternativePaymentToken","jpay":"#/components/schemas/AlternativePaymentToken","KNOT":"#/components/schemas/AlternativePaymentToken","loonie":"#/components/schemas/AlternativePaymentToken","Matrix":"#/components/schemas/AlternativePaymentToken","MaxiCash":"#/components/schemas/AlternativePaymentToken","Megafon":"#/components/schemas/AlternativePaymentToken","MiFinity-eWallet":"#/components/schemas/AlternativePaymentToken","miscellaneous":"#/components/schemas/AlternativePaymentToken","Bancontact":"#/components/schemas/AlternativePaymentToken","Bancontact-mobile":"#/components/schemas/AlternativePaymentToken","MTS":"#/components/schemas/AlternativePaymentToken","MuchBetter":"#/components/schemas/AlternativePaymentToken","Multibanco":"#/components/schemas/AlternativePaymentToken","Neosurf":"#/components/schemas/AlternativePaymentToken","Netbanking":"#/components/schemas/AlternativePaymentToken","Neteller":"#/components/schemas/AlternativePaymentToken","Nordea-Solo":"#/components/schemas/AlternativePaymentToken","OchaPay":"#/components/schemas/AlternativePaymentToken","online-bank-transfer":"#/components/schemas/AlternativePaymentToken","Onlineueberweisen":"#/components/schemas/AlternativePaymentToken","oriental-wallet":"#/components/schemas/AlternativePaymentToken","OXXO":"#/components/schemas/AlternativePaymentToken","P24":"#/components/schemas/AlternativePaymentToken","Pagadito":"#/components/schemas/AlternativePaymentToken","PagoEffectivo":"#/components/schemas/AlternativePaymentToken","Pagsmile-deposit-express":"#/components/schemas/AlternativePaymentToken","Pagsmile-lottery":"#/components/schemas/AlternativePaymentToken","PayCash":"#/components/schemas/AlternativePaymentToken","Payeer":"#/components/schemas/AlternativePaymentToken","PaymentAsia-crypto":"#/components/schemas/AlternativePaymentToken","Paymero":"#/components/schemas/AlternativePaymentToken","Perfect-money":"#/components/schemas/AlternativePaymentToken","Piastrix":"#/components/schemas/AlternativePaymentToken","PayTabs":"#/components/schemas/AlternativePaymentToken","Paysafecard":"#/components/schemas/AlternativePaymentToken","Paysafecash":"#/components/schemas/AlternativePaymentToken","Pay4Fun":"#/components/schemas/AlternativePaymentToken","Paynote":"#/components/schemas/AlternativePaymentToken","PinPay":"#/components/schemas/AlternativePaymentToken","phone":"#/components/schemas/AlternativePaymentToken","PhonePe":"#/components/schemas/AlternativePaymentToken","POLi":"#/components/schemas/AlternativePaymentToken","PostFinance-card":"#/components/schemas/AlternativePaymentToken","PostFinance-e-finance":"#/components/schemas/AlternativePaymentToken","QIWI":"#/components/schemas/AlternativePaymentToken","QPay":"#/components/schemas/AlternativePaymentToken","QQPay":"#/components/schemas/AlternativePaymentToken","rapyd-checkout":"#/components/schemas/AlternativePaymentToken","Resurs":"#/components/schemas/AlternativePaymentToken","SafetyPay":"#/components/schemas/AlternativePaymentToken","SEPA":"#/components/schemas/AlternativePaymentToken","Skrill":"#/components/schemas/AlternativePaymentToken","Skrill Rapid Transfer":"#/components/schemas/AlternativePaymentToken","SMSVoucher":"#/components/schemas/AlternativePaymentToken","Sofort":"#/components/schemas/AlternativePaymentToken","SparkPay":"#/components/schemas/AlternativePaymentToken","swift-dbt":"#/components/schemas/AlternativePaymentToken","Tele2":"#/components/schemas/AlternativePaymentToken","Terminaly-RF":"#/components/schemas/AlternativePaymentToken","ToditoCash-card":"#/components/schemas/AlternativePaymentToken","Trustly":"#/components/schemas/AlternativePaymentToken","UPayCard":"#/components/schemas/AlternativePaymentToken","UPI":"#/components/schemas/AlternativePaymentToken","USD-coin":"#/components/schemas/AlternativePaymentToken","VCreditos":"#/components/schemas/AlternativePaymentToken","VenusPoint":"#/components/schemas/AlternativePaymentToken","voucher":"#/components/schemas/AlternativePaymentToken","voucher-2":"#/components/schemas/AlternativePaymentToken","voucher-3":"#/components/schemas/AlternativePaymentToken","voucher-4":"#/components/schemas/AlternativePaymentToken","Webmoney":"#/components/schemas/AlternativePaymentToken","Webpay":"#/components/schemas/AlternativePaymentToken","Webpay-2":"#/components/schemas/AlternativePaymentToken","Webpay Card":"#/components/schemas/AlternativePaymentToken","WeChat Pay":"#/components/schemas/AlternativePaymentToken","XPay-P2P":"#/components/schemas/AlternativePaymentToken","XPay-QR":"#/components/schemas/AlternativePaymentToken","Yandex-money":"#/components/schemas/AlternativePaymentToken","Zotapay":"#/components/schemas/AlternativePaymentToken","Zimpler":"#/components/schemas/AlternativePaymentToken"}},"oneOf":[{"$ref":"#/components/schemas/PaymentCardToken"},{"$ref":"#/components/schemas/PayPalToken"},{"$ref":"#/components/schemas/BankAccountToken"},{"$ref":"#/components/schemas/DigitalWalletToken"},{"$ref":"#/components/schemas/PlaidAccountToken"},{"$ref":"#/components/schemas/KhelocardCardToken"},{"$ref":"#/components/schemas/KlarnaToken"},{"$ref":"#/components/schemas/AlternativePaymentToken"},{"$ref":"#/components/schemas/CryptocurrencyToken"}]}},"components/schemas/DigitalWalletValidation":{"id":"components/schemas/DigitalWalletValidation","kind":"json-schema","title":"DigitalWalletValidation","data":{"type":"object","required":["type"],"discriminator":{"propertyName":"type","mapping":{"Apple Pay":"#/components/schemas/ApplePayValidation"}},"properties":{"type":{"description":"Type of digital wallet to validate.","type":"string","enum":["Apple Pay"]}}}},"components/schemas/ApplePayValidation":{"id":"components/schemas/ApplePayValidation","kind":"json-schema","title":"ApplePayValidation","data":{"description":"Apple Pay session validation.","allOf":[{"$ref":"#/components/schemas/DigitalWalletValidation"},{"type":"object","required":["validationRequest"],"properties":{"type":{"type":"string"},"validationRequest":{"description":"Validation request.","type":"object","properties":{"validationUrl":{"type":"string","description":"Apple Pay SDK URL that is used to perform validation."},"domainName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain where the client code, such as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.rebilly.com/docs/developer-docs/framepay/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FramePay"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", is executed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain name must be registered in the Apple Pay console."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"./PostDigitalWalletOnboardingApplePay"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Register a domain for Apple Pay"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"www.example.com"},"displayName":{"type":"string","description":"Display name of your store.","example":"My Store"}},"writeOnly":true},"validationResponse":{"description":"Apple Pay SDK validation response.","type":"object","readOnly":true}}}]}},"components/schemas/PaymentInstructionToken":{"id":"components/schemas/PaymentInstructionToken","kind":"json-schema","title":"Payment token","data":{"type":"object","title":"Payment token","required":["token"],"properties":{"token":{"description":"Token ID of the payment.","type":"string"}}}},"components/schemas/PaymentInstructionInstrument":{"id":"components/schemas/PaymentInstructionInstrument","kind":"json-schema","title":"Payment instrument","data":{"type":"object","title":"Payment instrument","required":["paymentInstrumentId"],"properties":{"paymentInstrumentId":{"type":"string","description":"ID of the payment instrument.","maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"}}}},"components/schemas/PaymentInstructionMethods":{"id":"components/schemas/PaymentInstructionMethods","kind":"json-schema","title":"Payment Methods","data":{"type":"object","title":"Payment Methods","properties":{"methods":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of available payment methods."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only payment methods with at least one active gateway account are allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not specified all available payment methods are displayed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer can choose any of those as well as the payment instrument for them."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional steps occur via a redirect to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approvalUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PaymentMethod"}},"receivedBy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the cash receiver."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cash"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment method."},"children":[]}]}]}],"type":"string"},"reference":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is available only for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"check"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bank-transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment methods."},"children":[]}]}]}],"type":"string"}}}},"components/schemas/PaymentInstruction":{"id":"components/schemas/PaymentInstruction","kind":"json-schema","title":"PaymentInstruction","data":{"oneOf":[{"$ref":"#/components/schemas/PaymentInstructionToken"},{"$ref":"#/components/schemas/PaymentInstructionInstrument"},{"$ref":"#/components/schemas/PaymentInstructionMethods"},{"$ref":"#/components/schemas/PaymentCardCreatePlain"},{"$ref":"#/components/schemas/BankAccountCreatePlain"}]}},"components/schemas/TransactionQuery":{"id":"components/schemas/TransactionQuery","kind":"json-schema","title":"TransactionQuery","data":{"type":"object","properties":{"transactionId":{"$ref":"#/components/schemas/TransactionId"},"result":{"description":"Result of the transaction.","type":"string","readOnly":true,"enum":["abandoned","approved","canceled","declined","unknown"]},"status":{"description":"Status of the transaction.","type":"string","readOnly":true,"enum":["completed","conn-error","disputed","never-sent","offsite","partially-refunded","pending","refunded","sending","suspended","timeout","voided","waiting-approval","waiting-capture","waiting-gateway","waiting-refund"]},"amount":{"description":"Amount of the transaction.","type":"number","format":"double","readOnly":true},"currency":{"readOnly":true,"$ref":"#/components/schemas/CurrencyCode"}}}},"components/schemas/TransactionUpdate":{"id":"components/schemas/TransactionUpdate","kind":"json-schema","title":"TransactionUpdate","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the status of a transaction to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and optional currency and amount values."},"children":[]}]}]}],"required":["result"],"properties":{"result":{"description":"Result of the transaction.","type":"string","enum":["abandoned","approved","canceled","declined"]},"amount":{"description":"Amount of the transaction.","type":"number","format":"double"},"currency":{"description":"Currency of the transaction.","$ref":"#/components/schemas/CurrencyCode"}}}},"components/schemas/TransactionRefund":{"id":"components/schemas/TransactionRefund","kind":"json-schema","title":"TransactionRefund","data":{"type":"object","required":["amount"],"properties":{"amount":{"description":"Amount of the refund.","type":"number","format":"double"},"description":{"description":"Description of the refund.","type":"string","maxLength":255},"isProcessedOutside":{"description":"Specifies if the refund is processed outside of Rebilly.","type":"boolean","default":false}}}},"components/schemas/TransactionTimeline":{"id":"components/schemas/TransactionTimeline","kind":"json-schema","title":"TransactionTimeline","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the timeline message.","readOnly":true,"maxLength":50,"example":"tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC"},"type":{"description":"Type of timeline message.","type":"string","readOnly":true,"enum":["amount-adjusted","blocklist-matched","bump-offer-accepted","bump-offer-presented","bump-offer-rejected","customer-redirected-offsite","customer-returned","dcc-offer-accepted","dcc-offer-forced","dcc-offer-presented","dcc-offer-rejected","dispute-changed","dispute-created","dispute-forfeited","dispute-lost","dispute-responded","dispute-won","gateway-connection-failed","gateway-connection-timed-out","gateway-response-received","offsite-transaction-completed","quickbooks-payment-created","quickbooks-refund-receipt-created","quickbooks-transaction-task-failed","risk-score-changed","timeline-comment-created","transaction-abandoned","transaction-amount-discrepancy-found","transaction-approved","transaction-canceled","transaction-capture-delayed","transaction-captured","transaction-declined","transaction-discrepancy-found","transaction-disputed","transaction-initiated","transaction-payment-method-changed","transaction-partially-refunded","transaction-process-requested","transaction-processed","transaction-queried","transaction-reconciled","transaction-refunded","transaction-retried","transaction-rules-processed","transaction-scheduled-time-changed","transaction-timeout-resolved","transaction-updated","transaction-voided","transaction-waiting-gateway","transaction-waiting-gateway-completed"]},"triggeredBy":{"description":"Specifies who, or what, triggered the timeline message.","type":"string","readOnly":true,"enum":["rebilly","app","direct-api"]},"message":{"description":"Contents of the timeline message.","type":"string"},"extraData":{"$ref":"#/components/schemas/TimelineExtraData"},"occurredTime":{"description":"Date and time when the timeline message occurred.","readOnly":true,"$ref":"#/components/schemas/ServerTimestamp"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/FixedFeeFormula":{"id":"components/schemas/FixedFeeFormula","kind":"json-schema","title":"FixedFeeFormula","data":{"type":"object","required":["type","currency","amount"],"properties":{"type":{"description":"Type of fee.","type":"string","enum":["fixed-fee"]},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"description":"Amount of the fee.","type":"number","format":"double","example":10,"x-type":"Money"}}}},"components/schemas/Bips":{"id":"components/schemas/Bips","kind":"json-schema","title":"Bips","data":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basis points."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 100 bips = 1%, 1 bip = 0.01%."},"children":[]}]}]}],"format":"integer","minimum":0,"maximum":100000,"example":100}},"components/schemas/PercentageFeeFormula":{"id":"components/schemas/PercentageFeeFormula","kind":"json-schema","title":"PercentageFeeFormula","data":{"type":"object","required":["type","currency","bips"],"properties":{"type":{"description":"Type of fee.","type":"string","enum":["percentage"]},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"bips":{"$ref":"#/components/schemas/Bips"},"minAmount":{"description":"Minimum fee amount.\nThis value is applied when the calculated fee is less than the required minimum.","type":"number","format":"double","example":10,"x-type":"Money"}}}},"components/schemas/FeeFormula":{"id":"components/schemas/FeeFormula","kind":"json-schema","title":"FeeFormula","data":{"type":"object","description":"Formula that is used to calculate the fee.","discriminator":{"propertyName":"type","mapping":{"fixed-fee":"#/components/schemas/FixedFeeFormula","percentage":"#/components/schemas/PercentageFeeFormula"}},"oneOf":[{"$ref":"#/components/schemas/FixedFeeFormula"},{"$ref":"#/components/schemas/PercentageFeeFormula"}]}},"components/schemas/SettlementPeriod":{"id":"components/schemas/SettlementPeriod","kind":"json-schema","title":"SettlementPeriod","data":{"type":"object","description":"Instruction for calculating the settlement time.\nThe settlement time and settlement period anchor are used\nin conjunction with the transaction processed time,\nto calculate the time in which the amount settles.","discriminator":{"propertyName":"method","mapping":{"date-interval":"#/components/schemas/SchedulingMethodDateInterval","immediately":"#/components/schemas/SchedulingMethodImmediately"}},"oneOf":[{"$ref":"#/components/schemas/SchedulingMethodDateInterval"},{"$ref":"#/components/schemas/SchedulingMethodImmediately"}]}},"components/schemas/SettlementSettings":{"id":"components/schemas/SettlementSettings","kind":"json-schema","title":"SettlementSettings","data":{"type":"object","description":"Settlement settings.\nUse these settings to set up settlement accounts.","required":["settlementCurrency","settlementPeriod"],"properties":{"settlementCurrency":{"description":"Default settlement currency for all transactions.","$ref":"#/components/schemas/CurrencyCode"},"settlementPeriod":{"description":"Default settlement period for all transactions.","$ref":"#/components/schemas/SettlementPeriod"},"advancedSettings":{"description":"Advanced settlement settings.\nUse these settings to override either default settlement currency,\nperiod, or both for the transactions matched a filter.","type":"array","items":{"type":"object","required":["filter"],"properties":{"filter":{"type":"string","description":"Filter that is based on transaction properties and is used to determine when to apply the settings.","minLength":1,"maxLength":255,"example":"currency:EUR,GBP"},"settlementCurrency":{"$ref":"#/components/schemas/CurrencyCode"},"settlementPeriod":{"$ref":"#/components/schemas/SettlementPeriod"}}}}}}},"components/schemas/Fee":{"id":"components/schemas/Fee","kind":"json-schema","title":"Fee","data":{"type":"object","required":["type","name","formula"],"properties":{"id":{"type":"string","description":"ID of the fee.","readOnly":true,"maxLength":50,"example":"fee_01GQT145JX3XBRJ8K812Y3GRE9"},"type":{"description":"Type of fee.","type":"string","enum":["buy","sell"]},"name":{"type":"string","description":"Name of the fee.","minLength":1,"maxLength":255,"example":"A gateway fee"},"filter":{"description":"Filter that is based on the properties of the transaction and used to determine when to apply the fee.","minLength":1,"maxLength":255,"example":"type:sale,capture;result:approved","type":["string","null"]},"formula":{"$ref":"#/components/schemas/FeeFormula"},"settlementSettings":{"description":"Fee settlement settings.\nThis value overrides the gateway account financial settings of the transaction.","oneOf":[{"$ref":"#/components/schemas/SettlementSettings"},{"type":"null"}]},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/PatchFee":{"id":"components/schemas/PatchFee","kind":"json-schema","title":"PatchFee","data":{"type":"object","properties":{"type":{"description":"Type of fee.","type":"string","enum":["buy","sell"]},"name":{"type":"string","description":"Name of the fee.","minLength":1,"maxLength":255,"example":"A gateway fee"},"filter":{"description":"Filter that is based on the properties of the transaction and used to determine when to apply the fee.","minLength":1,"maxLength":255,"example":"type:sale,capture;result:approved","type":["string","null"]},"formula":{"$ref":"#/components/schemas/FeeFormula"},"settlementSettings":{"description":"Fee settlement settings.\nThis value overrides the gateway account financial settings of the transaction.","oneOf":[{"$ref":"#/components/schemas/SettlementSettings"},{"type":"null"}]}}}},"components/schemas/DepositRequest":{"id":"components/schemas/DepositRequest","kind":"json-schema","title":"DepositRequest","data":{"type":"object","required":["websiteId","customerId","currency"],"properties":{"id":{"type":"string","description":"ID of the deposit request.","readOnly":true,"maxLength":50,"example":"dep_req_0YVJ65BSGYC3EAT58SEX8KY6J7"},"websiteId":{"description":"ID of the website associated with the deposit.","type":"string","maxLength":50,"example":"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"transactionIds":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of transaction IDs that are associated with the deposit request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This list includes transactions that are created from the deposit request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is a maximum of one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction in the list."},"children":[]}]}]}],"items":{"type":"string","maxLength":50}},"status":{"description":"Status of the request.","type":"string","readOnly":true,"enum":["created","pending","initiated","attempted","completed","expired"],"x-enumDescriptions":{"created":"Request is created, but it has not been visited by a customer. This is a temporary state.","pending":"Request has been visited by a customer, but no funds have been deposited yet. This is a temporary state.","initiated":"A funds deposit transaction has been initiated. This is a temporary state.","attempted":"A funds deposit transaction was attempted and declined. This is a temporary state.","completed":"A funds deposit transaction has been approved and completed. This is a permanent state.","expired":"Request expired without an approved deposit transaction. This is a permanent state."}},"coinPurchase":{"type":"boolean","readOnly":true,"description":"Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.\nDetermined by the deposit amount strategy that is applied to the deposit request."},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"amounts":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of available deposit amounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not specified when a deposit is created, amounts are determined from the chosen deposit amount strategy."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/deposits/postdepositrequest#deposits/postdepositrequest/t=request&path=strategyid"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"strategyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"number","format":"double","minimum":0.01}},"defaultAmount":{"type":["number","null"],"format":"double","minimum":0.01,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of the default amount in the amounts list."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is calculated from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"defaultIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the deposit strategy that is applied to the deposit request."},"children":[]}]}]}]},"customAmount":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom amount restrictions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", custom amounts are prohibited."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not specified when a deposit request is created, amount restrictions are determined from the chosen strategy."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/deposits/postdepositrequest#deposits/postdepositrequest/t=request&path=strategyid"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"strategyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["minimum","multipleOf","maximum"],"properties":{"minimum":{"description":"Minimum custom amount.","type":"number","format":"double","minimum":0.01},"multipleOf":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple by which the custom amount increases."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is equal to 5.30, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipleOf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 0.50, the valid custom amount is 5.30, 5.80, 6.30, 6.80 and so on until the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maximum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is reached."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid custom amount must be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + X * "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipleOf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", where X is any non negative integer."},"children":[]}]}]}],"type":"number","format":"double","minimum":0.01},"maximum":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum custom amount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value must be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + X * "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipleOf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", where X is any positive integer."},"children":[]}]}]}],"type":"number","format":"double","minimum":0.01},"buttonText":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Localized overrides for the custom amount button label, as a map of locale codes to display strings."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"en-US\": \"Other amount\", \"fr\": \"Montant personnalisé\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or not provided, the default UI translation is used."},"children":[]}]}]}],"additionalProperties":{"type":"string"},"example":{"en-US":"Other amount","fr":"Montant personnalisé"}}}},"redirectUrl":{"description":"URL to redirect the customer to when a deposit is completed.\nThe default value is the website URL.","type":"string","maxLength":2083,"format":"uri"},"expirationTime":{"description":"Date and time when the deposit request expires.\nThe default expiration time is one hour from the time the request is created.","type":"string","format":"date-time"},"propertiesSchema":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines properties the user can complete when they use the hosted deposit form."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field accepts "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON-schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" drafts 4, 6, and 7."},"children":[]}]}]}],"type":["object","null"],"example":{"type":"object","properties":{"email":{"type":"string"},"max":{"type":"integer","minimum":0,"exclusiveMaximum":100}},"required":["email"]}},"properties":{"readOnly":true,"description":"Properties that are available for the user to complete when they use the hosted deposit form.\nUse this object to describe fields that are rendered and completed on the hosted deposit form.","type":["object","null"],"additionalProperties":{"type":"string"},"example":{"email":"email@example.com","max":"33"}},"notificationUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where a server-to-server POST notification is sent."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This notification is sent when the transaction result is finalized after a timeout or an offsite interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not interpret this notification as a confirmation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complete a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to confirm the result of the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure the request is not reattempted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when the result is confirmed, respond with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following placeholders are available to use in this URI: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{result}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These placeholders are replaced the with the transaction ID and result accordingly."},"children":[]}]}]}],"type":["string","null"],"maxLength":2083,"format":"uri"},"cashierToken":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Web Token (JWT) used to complete the deposit request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the deposit request is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"readOnly":true},"customFields":{"description":"Custom fields related to the deposit request.\nCustom field values are copied to created transactions if matching custom fields (name, type) exist.","$ref":"#/components/schemas/ResourceCustomFields"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","deposit","transactions"],"x-enumDescriptions":{"self":"Link to the deposit request.","deposit":"Link to the hosted deposit form.","transactions":"Link to the deposit request transactions collection."}}}}},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded objects that are requested by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true,"properties":{"customer":{"type":"object"},"website":{"type":"object"},"transactions":{"type":"array","maxItems":10,"description":"Most recent associated transactions."}}}}}},"components/schemas/PostDepositRequest":{"id":"components/schemas/PostDepositRequest","kind":"json-schema","title":"PostDepositRequest","data":{"type":"object","required":["websiteId","customerId","currency"],"properties":{"websiteId":{"description":"ID of the website associated with the deposit.","type":"string","maxLength":50,"example":"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"strategyId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of a deposit amount strategy to be applied for this request for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is not specified, a randomly selected deposit amount strategy with a matching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is applied for empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there is no matching deposit amount strategy, the default strategy with the following parameters is applied for empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" amounts:\n calculator: absolute\n baseAmount: 10\n increments: [10, 20]\n adjustBaseToLastDeposit: false\n customAmount:\n minimum: 1\n multipleOf: 1\n maximum: 10000\n","language":"yaml"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" amounts:\n calculator: absolute\n baseAmount: 10\n increments: [10, 20]\n adjustBaseToLastDeposit: false\n customAmount:\n minimum: 1\n multipleOf: 1\n maximum: 10000\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/deposits/postdepositstrategy"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a deposit amount strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"maxLength":50,"example":"dep_str_0YVJ64MAHTDPA97H8S7R5MYR1M"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"amounts":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of available deposit amounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not specified when a deposit request is created, amounts are determined from the chosen deposit amount strategy."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/deposits/postdepositrequest#deposits/postdepositrequest/t=request&path=strategyid"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"strategyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"number","format":"double","minimum":0.01}},"amountLimits":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deposit amount limit information. Set optional minimum and maximum deposit amounts. Limits override "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", deposit amount limits are not set."},"children":[]}]}]}],"minProperties":1,"properties":{"minimum":{"description":"Minimum deposit amount.","type":["number","null"],"format":"double","default":0,"minimum":0},"maximum":{"description":"Maximum deposit amount.","type":["number","null"],"format":"double","minimum":0}}},"customAmount":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom amount restrictions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", custom amounts are prohibited."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not specified when a deposit request is created, amount restrictions are determined from the chosen deposit amount strategy."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/deposits/postdepositrequest#deposits/postdepositrequest/t=request&path=strategyid"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"strategyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["minimum","multipleOf","maximum"],"properties":{"minimum":{"description":"Minimum custom amount.","type":"number","format":"double","minimum":0.01},"multipleOf":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple by which the custom amount increases."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is equal to 5.30, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipleOf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 0.50, the valid custom amount is 5.30, 5.80, 6.30, 6.80 and so on until the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maximum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is reached."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid custom amount must be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + X * "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipleOf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", where X is any non negative integer."},"children":[]}]}]}],"type":"number","format":"double","minimum":0.01},"maximum":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum custom amount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value must be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + X * "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipleOf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", where X is any positive integer."},"children":[]}]}]}],"type":"number","format":"double","minimum":0.01}}},"redirectUrl":{"description":"URL to redirect the customer to when a deposit is completed.\nThe default value is the website URL.","type":["string","null"],"maxLength":2083,"format":"uri"},"expirationTime":{"description":"Date and time when the deposit request expires.\nThe default expiration time is one hour after the time the request is created.","type":["string","null"],"format":"date-time"},"customPropertySetId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of a custom property set to apply to the request "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertiesSchema"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"maxLength":50,"example":"4f6cf35x-2c4y-483z-a0a9-158621f77a21"},"notificationUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where a server-to-server "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notification is sent."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This notification is sent when the transaction result is finalized after a timeout or an offsite interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not interpret this notification as a confirmation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complete a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to confirm the result of the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure the request is not reattempted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when the result is confirmed, respond with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following placeholders are available to use in this URI: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{result}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These placeholders are replaced the with the transaction ID and result accordingly."},"children":[]}]}]}],"type":["string","null"],"maxLength":2083,"format":"uri"}}}},"components/schemas/PostCashier":{"id":"components/schemas/PostCashier","kind":"json-schema","title":"PostCashier","data":{"type":"object","required":["customerId","websiteId","currency"],"properties":{"customerId":{"$ref":"#/components/schemas/CustomerId"},"websiteId":{"$ref":"#/components/schemas/WebsiteId"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"redirectUrl":{"description":"URL to redirect the customer to when a deposit or withdrawal is completed.\nThe default value is the website URL.","type":["string","null"],"maxLength":2083,"format":"uri"},"depositLimits":{"type":"object","writeOnly":true,"properties":{"minimum":{"type":"number","format":"double","minimum":0.01,"example":1000,"description":"Minimum deposit limit."},"maximum":{"type":"number","format":"double","example":10000,"description":"Maximum deposit limit."}},"description":"Deposit limits for the customer.\nThis object is used to set the minimum and maximum deposit limits for the customer."},"notificationUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where a server-to-server "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notification is sent."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This notification is sent when the transaction result is finalized after a timeout or an offsite interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not interpret this notification as a confirmation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complete a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to confirm the result of the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure the request is not reattempted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when the result is confirmed, respond with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following placeholders are available to use in this URI: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{result}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These placeholders are replaced the with the transaction ID and result accordingly."},"children":[]}]}]}],"type":["string","null"],"maxLength":2083,"format":"uri"}}}},"components/schemas/Cashier":{"id":"components/schemas/Cashier","kind":"json-schema","title":"Cashier","data":{"type":"object","required":["id","customerId","websiteId","redirectUrl","expirationTime","currency","balance","bonusBalance","pendingPayoutTotal","canWithdraw","notificationUrl"],"properties":{"id":{"type":"string","description":"Unique identifier of the cashier resource.","readOnly":true,"maxLength":50,"example":"cashier_0YV7DE4Z26DQSA1AC92FBJ7SEG"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"websiteId":{"$ref":"#/components/schemas/WebsiteId"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"redirectUrl":{"description":"URL to redirect the customer to when a deposit or withdrawal is completed.\nThe default value is the website URL.","type":["string","null"],"maxLength":2083,"format":"uri"},"balance":{"type":"number","format":"double","minimum":0,"description":"Customer's current balance.","readOnly":true,"example":1500},"bonusBalance":{"type":"number","format":"double","minimum":0,"description":"Bonus balance available to the customer.","readOnly":true,"example":0},"notificationUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where a server-to-server "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notification is sent."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This notification is sent when the transaction result is finalized after a timeout or an offsite interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not interpret this notification as a confirmation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complete a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to confirm the result of the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure the request is not reattempted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when the result is confirmed, respond with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following placeholders are available to use in this URI: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{result}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These placeholders are replaced the with the transaction ID and result accordingly."},"children":[]}]}]}],"type":["string","null"],"maxLength":2083,"format":"uri"},"expirationTime":{"description":"Date and time at which the cashier expires.\nThe default expiration time is one hour after the request is created.","type":["string","null"],"format":"date-time"},"pendingPayoutTotal":{"type":"number","format":"double","minimum":0,"description":"Sum of all payout requests that are currently in a pending state.\nThis value is also the maximum possible \"reverse withdrawal\" amount.","readOnly":true,"example":100},"canWithdraw":{"type":"boolean","readOnly":true,"description":"Specifies if the customer can initiate a withdrawal."},"lastDepositRequestId":{"type":"string","description":"ID of the last deposit request that is made for this cashier.","example":"dep_req_01K2HMPNTBDS92TA6W4EX3VJPM"},"cashierToken":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Web Token (JWT) for the cashier."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the associated deposit request is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"readOnly":true},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/DepositStrategy":{"id":"components/schemas/DepositStrategy","kind":"json-schema","title":"DepositStrategy","data":{"type":"object","required":["name","amounts","customAmount"],"properties":{"id":{"type":"string","description":"ID of the deposit amount strategy.","readOnly":true,"maxLength":50,"example":"dep_str_0YVJ64MAHTDPA97H8S7R5MYR1M"},"name":{"type":"string","description":"Name of the deposit amount strategy."},"filter":{"type":"string","description":"Filter that uses deposit request properties to determine if a deposit amount strategy is applicable for the deposit request.\nIf this field is empty, the deposit amount strategy is applicable for any request.","default":"","example":"depositRequest.currency:USD"},"amounts":{"type":"object","description":"Amounts configuration for deposit amount strategy.","required":["calculator","baseAmount","increments","defaultIndex"],"properties":{"calculator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deposit amounts calculator."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field specifies if amounts are calculated using an absolute or percentage calculation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amounts are specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"baseAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and increments are specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"increments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"baseAmount: 10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"increments: [20, 50, 100]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the calculator is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"absolute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the amounts displayed to the customer are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[10, 30, 60, 110]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the calculator is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the amounts displayed to the customer are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[10, 12, 15, 20]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["absolute","percent"]},"baseAmount":{"type":"number","format":"double","minimum":0.01,"description":"First amount that is displayed to customer."},"increments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of incremental amounts that are displayed to customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/deposits/postdepositstrategy#deposits/postdepositstrategy/t=request&path=amounts/calculator"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calculator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"number","format":"double","minimum":0.01}},"defaultIndex":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Index of the default amount in the amounts list that is displayed to the customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use it to specify which amount from the calculated amounts is preselected when the customer opens the deposit form."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hideBaseAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the 0 index refers to the first increment."},"children":[]}]}]}],"minimum":0,"default":0},"adjustBaseToLastDeposit":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the base amount must be adjusted based on the last deposit."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"baseAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is changed to the last successful deposit amount made using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/deposits/postdepositrequest"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a deposit request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the customer has no successful deposits, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"baseAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not adjusted."},"children":[]}]}]}]},"hideBaseAmount":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the base amount is hidden in the deposit form options."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the base amount is used to calculate increments but is not shown as a selectable option."},"children":[]}]}]}]},"minimumBaseAmount":{"type":["number","null"],"format":"double","minimum":0.01,"description":"Minimum value for the base amount.\nIf the base amount of the last deposit is less than this value,\nthis value is used as the base amount."}}},"customAmount":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom amount restrictions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", custom amounts are prohibited."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not specified when a deposit request is created, amount restrictions are determined from the chosen deposit amount strategy."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/deposits/postdepositrequest#deposits/postdepositrequest/t=request&path=strategyid"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"strategyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["minimum","multipleOf","maximum"],"properties":{"minimum":{"description":"Minimum custom amount.","type":"number","format":"double","minimum":0.01},"multipleOf":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple by which the custom amount increases."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is equal to 5.30, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipleOf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 0.50, the valid custom amount is 5.30, 5.80, 6.30, 6.80 and so on until the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maximum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is reached."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid custom amount must be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + X * "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipleOf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", where X is any non negative integer."},"children":[]}]}]}],"type":"number","format":"double","minimum":0.01},"maximum":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum custom amount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value must be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + X * "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipleOf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"where X is any positive integer."},"children":[]}]}]}],"type":"number","format":"double","minimum":0.01},"buttonText":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Localized overrides for the custom amount button label, as a map of locale codes to display strings."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"en-US\": \"Other amount\", \"fr\": \"Montant personnalisé\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or not provided, the default UI translation is used."},"children":[]}]}]}],"additionalProperties":{"type":"string"},"example":{"en-US":"Other amount","fr":"Montant personnalisé"}}}},"priority":{"type":"integer","description":"Non-negative integer value that specifies which deposit amount strategy is applied to the request.\nThe deposit amount strategy with the highest priority value is applied.","default":0,"minimum":0},"isActive":{"type":"boolean","description":"Specifies if the deposit amount strategy is active.","default":true},"coinPurchase":{"type":"boolean","description":"Specifies if deposits created from this strategy are coin purchases that credit the coin balance instead of the cash balance.","default":false},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/DepositCustomPropertySet":{"id":"components/schemas/DepositCustomPropertySet","kind":"json-schema","title":"DepositCustomPropertySet","data":{"type":"object","required":["name","properties"],"properties":{"id":{"type":"string","description":"ID of the deposit property set.","readOnly":true,"maxLength":50,"example":"dep_prop_0YVJ640MB4CXVB8KXBRW3B79R9"},"name":{"type":"string","description":"Name of the custom property set."},"properties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines properties the user can complete when they use the hosted deposit form."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field accepts "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://json-schema.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON-schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" drafts 4, 6, and 7."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted properties types are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"integer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"array"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/configure-custom-hosted-deposit-properties/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure custom hosted deposit properties"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","example":{"type":"object","properties":{"email":{"type":"string"},"max":{"type":"integer","minimum":0,"exclusiveMaximum":100}},"required":["email"]}},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/PayoutRequestBlockReason":{"id":"components/schemas/PayoutRequestBlockReason","kind":"json-schema","title":"PayoutRequestBlockReason","data":{"type":"string","description":"Reason for blocking the payout request.","enum":["fraud-suspected","kyc-verification-required","aml-review","account-verification","duplicate-request","insufficient-documentation","risk-review","other"]}},"components/schemas/PayoutRequestSplitReason":{"id":"components/schemas/PayoutRequestSplitReason","kind":"json-schema","title":"PayoutRequestSplitReason","data":{"type":"string","description":"Reason for splitting the payout request.","enum":["payment-instrument-limit","processor-limit","risk-review","compliance-review","partial-processing","operational-reconciliation","other"]}},"components/schemas/PayoutRequestAllocation":{"id":"components/schemas/PayoutRequestAllocation","kind":"json-schema","title":"PayoutRequestAllocation","data":{"type":"object","required":["payoutRequestId","paymentInstrumentId","gatewayAccountId","amount","currency"],"properties":{"id":{"type":"string","readOnly":true,"description":"ID of the resource.","maxLength":50,"example":"pra_0YVDMDE2BMC6KBB5MX76RF6T80"},"payoutRequestId":{"description":"ID of the payout request associated with this allocation.","readOnly":true,"type":"string","maxLength":50,"example":"pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"},"batchId":{"description":"ID of the payout request batch that contains the payout request for this allocation.","readOnly":true,"type":["string","null"],"maxLength":50,"example":"preq_batch_0YVDMDE2BMC6KBB5MX76RF6T80"},"paymentInstrumentId":{"type":"string","description":"ID of the payment instrument allocated to the payout request.","maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"},"paymentMethod":{"description":"Payment method of the allocation.","allOf":[{"$ref":"#/components/schemas/PaymentMethod"}],"readOnly":true},"gatewayAccountId":{"type":"string","description":"ID of the gateway account to use for processing this allocation.","maxLength":50,"example":"gateway_0YVB8KPKNXCBR9EDX7JHSED75N"},"gatewayName":{"type":"string","description":"Name of the gateway account to use for processing this allocation.","maxLength":50,"example":"TestProcessor"},"gatewayPayoutInstruction":{"description":"Payout configuration of the gateway account that processes this allocation.","readOnly":true,"type":["string","null"],"enum":["all","covered-payout","approved-payment","none",null],"x-enumDescriptions":{"all":"Payout any amount from this gateway.","covered-payout":"Payout from this gateway if it previously processed a payment for the same,\nor a greater, amount.","approved-payment":"Payout any amount from this gateway if it processed an earlier payment.\nThe customer must have a previously approved transaction,\nin the same currency, on this gateway.","none":"Do not allow any payouts with this gateway."},"example":"covered-payout"},"amount":{"description":"Amount allocated to this payment instrument.","type":"number","format":"double","x-type":"Money"},"exposureAmount":{"description":"Total approved sales and captures minus approved payouts for the customer,\ngateway account, and payment instrument, in the allocation currency.","readOnly":true,"type":"number","format":"double","x-type":"Money","example":2},"currency":{"description":"Currency of the payout request allocation.","$ref":"#/components/schemas/CurrencyCode"},"status":{"description":"Status of this payout request allocation.","type":"string","enum":["pending","queued","processing","waiting-completion","completed","failed","canceled","declined"],"x-enumDescriptions":{"pending":"Allocation was created and is waiting to be processed.","queued":"Allocation is queued for processing.","processing":"Allocation is being processed and a transaction is being created.","waiting-completion":"Allocation transaction is processing asynchronously and has not yet reached a terminal state.","completed":"Allocation was successfully processed and the transaction was approved.","failed":"Allocation was not processed because of an error.","canceled":"Allocation was canceled before processing.","declined":"Allocation was declined by the gateway."}},"transactionId":{"description":"ID of the transaction that is created when processing this allocation, if applicable.","type":["string","null"],"readOnly":true,"maxLength":50,"example":"txn_0YVB8KPKNXCBR9EDX7JHSED75N"},"transactionResult":{"description":"Result of the transaction created for this allocation, if applicable.","readOnly":true,"type":["string","null"],"enum":["abandoned","approved","canceled","declined","unknown",null]},"transactionStatus":{"description":"Status of the transaction created for this allocation, if applicable.","readOnly":true,"type":["string","null"],"enum":["completed","conn-error","disputed","never-sent","offsite","partially-refunded","pending","refunded","sending","timeout","voided","waiting-approval","waiting-capture","waiting-gateway","waiting-refund",null]},"createdTime":{"description":"Date and time when the allocation for the payout request was created.","$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","transaction","gatewayAccount","payoutRequest","paymentInstrument"]}}}}}}},"components/schemas/PayoutRequestCancellation":{"id":"components/schemas/PayoutRequestCancellation","kind":"json-schema","title":"PayoutRequestCancellation","data":{"description":"Reason the payout request is canceled.","type":["object","null"],"readOnly":true,"properties":{"canceledBy":{"description":"Specifies who initiated the cancellation.","type":"string","default":"customer","enum":["merchant","customer","system"]},"description":{"description":"Description of the cancellation reason in free form.","type":"string","maxLength":255}}}},"components/schemas/PayoutRequest":{"id":"components/schemas/PayoutRequest","kind":"json-schema","title":"PayoutRequest","data":{"type":"object","required":["websiteId","customerId","currency","amount"],"properties":{"id":{"type":"string","readOnly":true,"description":"Unique resource ID.","maxLength":50,"example":"pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"},"websiteId":{"$ref":"#/components/schemas/WebsiteId"},"customerId":{"description":"ID of the customer who is requesting a payout.","$ref":"#/components/schemas/CustomerId"},"paymentInstrumentId":{"type":["string","null"],"description":"ID of the requested payment instrument to offer for the payout.","maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"},"splitFromPayoutRequestId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the payout request from which this request is split,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this request is not created by a split operation."},"children":[]}]}]}],"type":["string","null"],"readOnly":true,"maxLength":50,"example":"pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"},"mergedIntoPayoutRequestId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the payout request that this request is merged into,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if it is not merged into another request."},"children":[]}]}]}],"type":["string","null"],"readOnly":true,"maxLength":50,"example":"pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"},"currency":{"description":"Currency of the payout.","$ref":"#/components/schemas/CurrencyCode"},"amount":{"description":"Amount of the payout.","type":"number","format":"double","x-type":"Money"},"availableAmount":{"description":"Available payout request amount that has not been allocated.","readOnly":true,"type":"number","format":"double","x-type":"Money"},"description":{"description":"Description of payout request.","type":["string","null"]},"status":{"description":"Status of the request.","type":"string","readOnly":true,"enum":["pending","ready","approved","in-progress","fulfilled","canceled","split","merged"],"x-enumDescriptions":{"pending":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request was created by the customer and is in a pending state for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/websites/putwebsite#websites/putwebsite/t=request&path=settings/payoutrequest/pendingperiodhours"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configured pending period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", unless it is marked as ready by a member of your organization."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When automatic readiness is enabled, the payout request transitions to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state after the pending period elapses and the configured "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/websites/putwebsite#websites/putwebsite/t=request&path=settings/payoutrequest/automaticreadinesstime"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transition time"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is reached."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the configured "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/websites/putwebsite#websites/putwebsite/t=request&path=settings/payoutrequest/automaticreadinessenabled"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"automaticReadinessEnabled"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" setting, this may be the initial status assigned to new payout requests, or this status may not be used."},"children":[]}]}]}],"ready":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request was created by the customer and is ready for review."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the configured "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/websites/putwebsite#websites/putwebsite/t=request&path=settings/payoutrequest/automaticreadinessenabled"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"automaticReadinessEnabled"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" setting, this may be the initial status assigned to new payout requests."},"children":[]}]}]}],"approved":"Request was reviewed, approved, and is ready for processing.","in-progress":"Request has allocations and is being processed.","fulfilled":"Request is fully paid out.","canceled":"Request is canceled by merchant or customer.","split":"Request was split into two or more payout requests.","merged":"Request was merged into another payout request."}},"blocked":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the payout request is blocked or unblocked."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When blocked, the payout request cannot transition to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in-progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"split"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allocation creation, allocation processing, and cancellation of pending allocations are also prevented."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A blocked payout request can still transition to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fulfilled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status if allocation processing starts before the payout request is blocked."},"children":[]}]}]}],"type":"boolean","readOnly":false,"example":false},"blockReason":{"oneOf":[{"$ref":"#/components/schemas/PayoutRequestBlockReason"},{"type":"null"}]},"splitReason":{"oneOf":[{"$ref":"#/components/schemas/PayoutRequestSplitReason"},{"type":"null"}]},"batchId":{"description":"ID of the payout request batch that contains this request.","type":["string","null"],"readOnly":true,"maxLength":50,"example":"preq_batch_0YVDMDE2BMC6KBB5MX76RF6T80"},"selectPaymentInstrumentUrl":{"readOnly":true,"type":"string","format":"uri","description":"URL for the customer to select a preferred payment instrument."},"allocations":{"type":"array","description":"List of payout request allocations for the payout request.","readOnly":true,"items":{"$ref":"#/components/schemas/PayoutRequestAllocation"}},"selectedPaymentInstrumentRedirectUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the customer is redirected when a payment instrument is selected. The default value is the website URL."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{id}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a placeholder for the payout request ID."},"children":[]}]}]}],"type":"string","format":"uri","maxLength":2083,"example":"https://example.com/payout-request-success"},"cancellationReason":{"$ref":"#/components/schemas/PayoutRequestCancellation"},"createdTime":{"description":"Date and time when the payout request is created.","$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"description":"Date and time when the payout request is updated.","$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","splitFrom","mergedInto","paymentInstrument"]}}}}}}},"components/schemas/PayoutRequestSplit":{"id":"components/schemas/PayoutRequestSplit","kind":"json-schema","title":"PayoutRequestSplit","data":{"type":"object","required":["amounts","splitReason"],"properties":{"amounts":{"description":"Amounts for each new payout request.\nOne request is created per amount.\nProvide at least two amounts.\nEach amount must be greater than zero.\nThe sum must equal the original payout request amount.","type":"array","minItems":2,"maxItems":100,"items":{"type":"number","format":"double","x-type":"Money","exclusiveMinimum":0},"example":[50,30,20]},"splitReason":{"$ref":"#/components/schemas/PayoutRequestSplitReason"},"splitDescription":{"description":"Additional description for splitting the payout request.","type":["string","null"],"maxLength":255}}}},"components/schemas/PayoutRequestTimelineMessage":{"id":"components/schemas/PayoutRequestTimelineMessage","kind":"json-schema","title":"PayoutRequestTimelineMessage","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the message.","readOnly":true,"maxLength":50,"example":"tlm_0YVDMDE2BMC6KBB5MX76RF6T80"},"type":{"type":"string","description":"Type of timeline event.","readOnly":true,"enum":["timeline-comment-created","payout-request-created","payout-request-ready","payout-request-returned-to-pending","payout-request-approved","payout-request-approval-undone","payout-request-allocated","payout-request-processing-started","payout-request-fulfilled","payout-request-canceled","payout-request-reversed","payout-request-blocked","payout-request-unblocked"]},"occurredTime":{"description":"Date and time when the timeline event occurred.","$ref":"#/components/schemas/ServerTimestamp"},"triggeredBy":{"type":"string","description":"Who or what triggered this event.","readOnly":true,"enum":["rebilly","app","direct-api"]},"message":{"type":"string","description":"Human-readable message describing the timeline event."},"extraData":{"$ref":"#/components/schemas/TimelineExtraData"}},"required":["id","type","occurredTime","triggeredBy","message","extraData"]}},"components/schemas/PayoutRequestBatch":{"id":"components/schemas/PayoutRequestBatch","kind":"json-schema","title":"PayoutRequestBatch","data":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"ID of the batch.","maxLength":50,"example":"preq_batch_0YVDMDE2BMC6KBB5MX76RF6T80"},"userId":{"type":"string","readOnly":true,"description":"ID of the user who created the batch.","maxLength":50,"example":"usr_0YVCEENYJ3D7Q9EN6BN16HA0G4"},"totalCount":{"description":"Total number of payout requests in the batch.","type":"integer","readOnly":true,"minimum":0,"example":10},"customerCount":{"description":"Number of unique customers in the batch.","type":"integer","readOnly":true,"minimum":0,"example":3},"totalAmountByCurrency":{"description":"Total payout amount grouped by currency in the batch.","type":"array","readOnly":true,"items":{"type":"object","additionalProperties":false,"required":["currency","amount"],"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"type":"number"}}}},"description":{"description":"Optional description of the batch.","type":["string","null"],"maxLength":255,"example":"Batch processed on 2024-01-15"},"allocationOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order for auto-allocation of payout requests in this batch."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set, this field overrides the organization-level allocation order during batch auto-allocation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selected-payment-instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exactly once."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment-card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (payment cards), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alternative-payment-methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (catch-all for alternative payment methods), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selected-payment-instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (customer-requested instrument), or any payment method API name (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paypal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Interac-eTransfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":["array","null"],"items":{"type":"string"},"minItems":2,"maxItems":25,"uniqueItems":true,"example":["paypal","Interac-eTransfer","payment-card","alternative-payment-methods","selected-payment-instrument"]},"createdTime":{"description":"Date and time when the batch was created.","$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"description":"Date and time when the batch was last updated.","$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","payoutRequests"]}}}}}}},"components/schemas/OrderPreview":{"id":"components/schemas/OrderPreview","kind":"json-schema","title":"OrderPreview","data":{"type":"object","required":["websiteId","items"],"properties":{"websiteId":{"writeOnly":true,"allOf":[{"$ref":"#/components/schemas/WebsiteId"}]},"items":{"description":"Items details.","type":"array","writeOnly":true,"minItems":1,"items":{"type":"object","required":["quantity"],"properties":{"planId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either this field or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object must be provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"plan.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X","deprecated":true},"plan":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either this object or the deprecated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"planId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be provided."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/OriginalPlan"},{"$ref":"#/components/schemas/FlexiblePlan"}]},"quantity":{"description":"Number of product units in the specified plan.","type":"integer","minimum":0,"maximum":1000000000}},"oneOf":[{"required":["plan"],"properties":{"planId":{"not":{}}}},{"required":["planId"],"properties":{"plan":{"not":{}}}},{"required":["plan","planId"]}]}},"billingAddress":{"description":"Billing address details.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"deliveryAddress":{"description":"Delivery address details.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"couponIds":{"type":"array","writeOnly":true,"description":"List of coupons that are applied to the order.","items":{"type":"string"}},"currency":{"readOnly":true,"$ref":"#/components/schemas/CurrencyCode"},"lineItems":{"type":"array","description":"List of purchase items.","readOnly":true,"items":{"type":"object","properties":{"type":{"description":"Type of transaction.","type":"string","enum":["debit","credit"]},"description":{"description":"Description of the purchase item.","type":"string"},"unitPrice":{"description":"Unit price of the purchase item.","type":"number","format":"double","example":49.95},"quantity":{"description":"Total quantity of the purchase item.","type":"number","format":"integer"},"price":{"description":"Total cost of the purchase item.","type":"number","format":"double"},"planId":{"type":"string","description":"ID of the related plan.","maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"},"productId":{"type":"string","description":"ID of the related product.","maxLength":50,"example":"prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"}}}},"shippingRates":{"type":"array","description":"Available shipping rates.","readOnly":true,"items":{"$ref":"#/components/schemas/ShippingOption"}},"taxes":{"type":"array","description":"Taxes applied to the purchase.","readOnly":true,"items":{"type":"object","properties":{"amount":{"description":"Amount of tax that is due.","type":"number","format":"double"},"description":{"type":"string","description":"Description of the tax."}}}},"discounts":{"type":"array","description":"Discounts applied to the purchase.","readOnly":true,"items":{"type":"object","properties":{"couponId":{"type":"string","description":"ID of a coupon that is associated with the purchase.","maxLength":50,"example":"cpn_0YVCNKF81GD778N4YNVGDJK558"},"amount":{"description":"Total amount of discount from the coupon.","type":"number","format":"double"},"description":{"description":"Description of the discount.","type":"string"}}}},"subtotalAmount":{"description":"Subtotal amount of the purchase.","type":"number","format":"double","readOnly":true},"taxAmount":{"description":"Tax amount of the purchase.","type":"number","format":"double","readOnly":true},"shippingAmount":{"description":"Shipping amount of the purchase.","type":"number","format":"double","readOnly":true},"discountsAmount":{"description":"Total discount amount of the purchase.","type":"number","format":"double","readOnly":true},"total":{"description":"Total amount of the purchase.","type":"number","format":"double","readOnly":true},"initialAmounts":{"type":"object","description":"Total amounts of the initial invoice.\nThis displays the amount the customer pays initially.","readOnly":true,"properties":{"amount":{"description":"Total amount of the initial invoice.","type":"number","x-type":"Money","format":"double"},"subtotalAmount":{"description":"Subtotal amount of the initial invoice.","type":"number","x-type":"Money","format":"double"},"discountAmount":{"description":"Discount amount applied to the initial invoice.","type":"number","x-type":"Money","format":"double"},"shippingAmount":{"description":"Shipping amount applied to the initial invoice.","type":"number","x-type":"Money","format":"double"},"taxAmount":{"description":"Tax amount applied to the initial invoice.","type":"number","x-type":"Money","format":"double"}}},"recurringAmounts":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total amounts of the recurring invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes recurring items only."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the order does not have recurring items, the value of this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"readOnly":true,"properties":{"amount":{"description":"Total amount of the recurring invoice.","type":"number","x-type":"Money","format":"double"},"subtotalAmount":{"description":"Subtotal amount of the recurring invoice.","type":"number","x-type":"Money","format":"double"},"discountAmount":{"description":"Discount amount applied to the recurring invoice.","type":"number","x-type":"Money","format":"double"},"shippingAmount":{"description":"Shipping amount applied to the recurring invoice.","type":"number","x-type":"Money","format":"double"},"taxAmount":{"description":"Tax amount applied to the recurring invoice.","type":"number","x-type":"Money","format":"double"}}},"shipping":{"writeOnly":true,"$ref":"#/components/schemas/Shipping"}}}},"components/schemas/DashboardMetric":{"id":"components/schemas/DashboardMetric","kind":"json-schema","title":"DashboardMetric","data":{"type":"string","description":"Type of dashboard metric.","enum":["approvalRate","salesCount","salesValue","refundsValue","chargebacksCount","chargebacksValue","transactionsCount","redeemedCouponsCount","newLeadsCount","newCustomersCount","appliedCouponsCount","trialConversionsCount","trialConversionsRate","renewalSuccessRate","renewalsCount","newTrialsCount","reactivationsCount","successfulRetriesCount","invoicedRevenue","churnCount","churnRate","cancellationsCount","cancellationsRate","activeSubscriptionsCount","newSubscriptionsCount","upgradesCount","downgradesCount","monthlyRecurringRevenue","annualRecurringRevenue","averageRevenuePerCustomer","customerLifetimeValue","addressProofAcceptanceRate","identityProofAcceptanceRate","fundsProofAcceptanceRate","purchaseProofAcceptanceRate","creditFileProofAcceptanceRate","kycAcceptanceRate","kycReviewTime","kycRejectionRate","kycAccuracyRate","addressProofAccuracyRate","identityProofAccuracyRate","creditFileProofAccuracyRate","kycRequestCount","kycRequestAbandonmentRate","kycRequestAttemptedRate","kycRequestFailureRate","kycRequestFulfillmentRate","kycRequestExpirationRate"]}},"components/schemas/EventType":{"id":"components/schemas/EventType","kind":"json-schema","title":"EventType","data":{"type":"string","description":"Type of Rebilly event.","readOnly":true,"enum":["account-password-reset-requested","account-verification-requested","aml-list-possibly-matched","application-instance-disabled","application-instance-enabled","balance-transaction-settled","coupon-application-removed","coupon-applied","coupon-expiration-modified","coupon-expired","coupon-issued","coupon-modified","coupon-redeemed","coupon-redemption-canceled","customer-created","customer-one-time-password-requested","customer-updated","dispute-created","dispute-modified","experian-check-performed","gateway-account-downtime-ended","gateway-account-downtime-started","gateway-account-limit-reached","gateway-account-onboarding-completed","gateway-account-onboarding-failed","gateway-account-requested","hard-usage-limit-reached","invoice-abandoned","invoice-issued","invoice-modified","invoice-paid","invoice-partially-paid","invoice-partially-refunded","invoice-past-due","invoice-past-due-reminder","invoice-refunded","invoice-revenue-recognized","invoice-tax-calculation-failed","invoice-voided","kyc-document-accepted","kyc-document-modified","kyc-document-rejected","kyc-request-fulfilled","order-abandon-reminder","order-abandoned","order-completed","payment-card-created","payment-card-expiration-reminder","payment-card-expired","payment-instrument-modified","payout-request-created","payout-request-modified","quote-accepted","quote-canceled","quote-created","quote-expired","quote-issued","quote-recalled","quote-rejected","quote-updated","ready-to-pay-requested","ready-to-payout-requested","renewal-invoice-issued","renewal-invoice-payment-canceled","renewal-invoice-payment-declined","risk-score-changed","soft-usage-limit-reached","subscription-activated","subscription-canceled","subscription-churned","subscription-created","subscription-downgraded","subscription-items-changed","subscription-modified","subscription-pause-created","subscription-pause-modified","subscription-pause-revoked","subscription-paused","subscription-quantity-filled-limit-reached","subscription-reactivated","subscription-renewal-reminder","subscription-renewed","subscription-resumed","subscription-trial-converted","subscription-trial-end-changed","subscription-trial-end-reminder","subscription-trial-ended","subscription-upgraded","transaction-amount-discrepancy-found","transaction-declined","transaction-discrepancy-found","transaction-process-requested","transaction-processed","trial-usage-limit-reached","order-delinquency-reached","autodeposit-lookup-performed"]}},"components/schemas/RiskScoreBoolean":{"id":"components/schemas/RiskScoreBoolean","kind":"json-schema","title":"RiskScoreBoolean","data":{"type":["object","null"],"required":["value"],"properties":{"value":{"type":"integer","description":"Value added to the risk score of the transaction."}}}},"components/schemas/RiskScoreBracket":{"id":"components/schemas/RiskScoreBracket","kind":"json-schema","title":"RiskScoreBracket","data":{"type":["object","null"],"required":["brackets"],"properties":{"brackets":{"description":"Risk factor values range with corresponding risk score increment value.\nThe first matched bracket is applied.","type":"array","minItems":1,"items":{"type":"object","required":["value"],"properties":{"start":{"description":"Minimal risk factor value when condition is applied.","type":["integer","null"],"minimum":0},"end":{"description":"Maximal risk factor value when condition is applied.","type":["integer","null"],"minimum":1},"value":{"type":"integer","description":"Value added to the risk score of the transaction."}},"oneOf":[{"required":["start"],"properties":{"end":{"not":{}}}},{"required":["end"],"properties":{"start":{"not":{}}}},{"required":["start","end"]}]}}}}},"components/schemas/RiskScoreRules":{"id":"components/schemas/RiskScoreRules","kind":"json-schema","title":"RiskScoreRules","data":{"type":"object","description":"Risk score rules.","required":["isProxy","isVpn","isTor","isHosting","hasMismatchedBillingAddressCountry","hasMismatchedBankCountry","hasMismatchedTimeZone","hasMismatchedHolderName","hasFakeName","isHighRiskCountry","paymentInstrumentVelocity","declinedPaymentInstrumentVelocity","deviceVelocity","ipVelocity","emailVelocity","billingAddressVelocity","isRebill","isRetry","customerLifetimeValue","browserAdBlockEnabled","paymentInstrumentApprovedTransactionCount","customerVelocity"],"properties":{"isProxy":{"description":"Specifies whether the customer's IP address is related to a proxy.","$ref":"#/components/schemas/RiskScoreBoolean"},"isVpn":{"description":"Specifies whether the customer's IP address is related to a VPN.","$ref":"#/components/schemas/RiskScoreBoolean"},"isTor":{"description":"Specifies whether the customer's IP address is related to TOR.","$ref":"#/components/schemas/RiskScoreBoolean"},"isHosting":{"description":"Specifies whether the customer's IP address is related to hosting.","$ref":"#/components/schemas/RiskScoreBoolean"},"hasMismatchedBillingAddressCountry":{"description":"Specifies whether the customer's billing address country and geo-IP address are not the same.","$ref":"#/components/schemas/RiskScoreBoolean"},"hasMismatchedBankCountry":{"description":"Specifies whether the customer's bank country and geo-IP address are not the same.","$ref":"#/components/schemas/RiskScoreBoolean"},"hasMismatchedTimeZone":{"description":"Specifies whether the customer's browser time zone and the IP address associated time zone are not the same.","$ref":"#/components/schemas/RiskScoreBoolean"},"hasMismatchedHolderName":{"description":"Specifies whether the customer's billing address name and primary address name are not the same.","$ref":"#/components/schemas/RiskScoreBoolean"},"hasFakeName":{"description":"Specifies whether the holder name seems fake.","$ref":"#/components/schemas/RiskScoreBoolean"},"isHighRiskCountry":{"description":"Specifies whether the geo-IP country, or the customer's billing country, is considered a high risk country.","$ref":"#/components/schemas/RiskScoreBoolean"},"paymentInstrumentVelocity":{"description":"Number of transactions for this payment instrument, based on fingerprint, in the last 24 hours.","$ref":"#/components/schemas/RiskScoreBracket"},"declinedPaymentInstrumentVelocity":{"description":"Number of declined transactions for this payment instrument fingerprint in the last 24 hours.","$ref":"#/components/schemas/RiskScoreBracket"},"deviceVelocity":{"description":"Number of transactions for this device, based on fingerprint, in the last 24 hours.","$ref":"#/components/schemas/RiskScoreBracket"},"ipVelocity":{"description":"Number of transactions for this IP address in the last 24 hours.","$ref":"#/components/schemas/RiskScoreBracket"},"emailVelocity":{"description":"Number of transactions for this email address in the last 24 hours.","$ref":"#/components/schemas/RiskScoreBracket"},"billingAddressVelocity":{"description":"Number of transactions for this billing address in the last 24 hours.","$ref":"#/components/schemas/RiskScoreBracket"},"isRebill":{"description":"Specifies whether the transaction is one of a number of recurring payments in a subscription, excluding trials or setup fees.","$ref":"#/components/schemas/RiskScoreBoolean"},"isRetry":{"description":"Specifies whether the transaction is a retry.","$ref":"#/components/schemas/RiskScoreBoolean"},"customerLifetimeValue":{"description":"Total revenue from the customer, in USD.","$ref":"#/components/schemas/RiskScoreBracket"},"browserAdBlockEnabled":{"description":"Specifies whether an ad blocker was detected.","$ref":"#/components/schemas/RiskScoreBoolean"},"paymentInstrumentApprovedTransactionCount":{"description":"Number of approved transactions for this payment instrument.","$ref":"#/components/schemas/RiskScoreBracket"},"customerVelocity":{"description":"Number of transactions for this customer in the last 24 hours.","$ref":"#/components/schemas/RiskScoreBracket"}}}},"components/schemas/RiskScoreBlocklistPermanentRule":{"id":"components/schemas/RiskScoreBlocklistPermanentRule","kind":"json-schema","title":"RiskScoreBlocklistPermanentRule","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rule that permanently blocklists items when TTL is equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["riskScoreThreshold"],"properties":{"riskScoreThreshold":{"type":"integer","description":"Pass and fail threshold for the blocklist.","minimum":1}}}},"components/schemas/RiskScoreBlocklistPermanentRules":{"id":"components/schemas/RiskScoreBlocklistPermanentRules","kind":"json-schema","title":"RiskScoreBlocklistPermanentRules","data":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items permanently blocklisted when TTL is equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"address":{"description":"House number and ZIP code of the customer's address.","$ref":"#/components/schemas/RiskScoreBlocklistPermanentRule"},"bankAccount":{"description":"Bank account for the charge.","$ref":"#/components/schemas/RiskScoreBlocklistPermanentRule"},"bin":{"description":"Bank Identification Number (BIN) of the payment card for the charge.","$ref":"#/components/schemas/RiskScoreBlocklistPermanentRule"},"country":{"description":"Country where the customer is making the purchase, and country of the payment card billing address.","$ref":"#/components/schemas/RiskScoreBlocklistPermanentRule"},"customerId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rebilly "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the customer making the purchase."},"children":[]}]}]}],"$ref":"#/components/schemas/RiskScoreBlocklistPermanentRule"},"email":{"description":"Email address of the customer making the purchase.","$ref":"#/components/schemas/RiskScoreBlocklistPermanentRule"},"emailDomain":{"description":"Email address domain of the customer making the purchase.","$ref":"#/components/schemas/RiskScoreBlocklistPermanentRule"},"fingerprint":{"description":"Fingerprint of the user's device.\nA device fingerprint is a unique token that is used to identify the user.\nThe device fingerprint is generated based on device attributes,\nsuch as: hardware, software, IP address, language, browser, and more.","$ref":"#/components/schemas/RiskScoreBlocklistPermanentRule"},"ipAddress":{"description":"IP address of the customer making the purchase.","$ref":"#/components/schemas/RiskScoreBlocklistPermanentRule"},"paymentCard":{"description":"Payment card number being charged.","$ref":"#/components/schemas/RiskScoreBlocklistPermanentRule"}}}},"components/schemas/RiskScoreBlocklistTemporaryRule":{"id":"components/schemas/RiskScoreBlocklistTemporaryRule","kind":"json-schema","title":"RiskScoreBlocklistTemporaryRule","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items temporarily blocklisted when TTL is greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["riskScoreThreshold","ttl"],"properties":{"riskScoreThreshold":{"type":"integer","description":"Pass and fail threshold for the blocklist.","minimum":1},"ttl":{"type":"integer","description":"Amount of seconds a blocklist exists before it expires.\nThis value must be greater than 0.","minimum":1}}}},"components/schemas/RiskScoreBlocklistTemporaryRules":{"id":"components/schemas/RiskScoreBlocklistTemporaryRules","kind":"json-schema","title":"RiskScoreBlocklistTemporaryRules","data":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items temporarily blocklisted when TTL is greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"address":{"description":"House number and ZIP code of the customer's address.","$ref":"#/components/schemas/RiskScoreBlocklistTemporaryRule"},"bankAccount":{"description":"Bank account for the charge.","$ref":"#/components/schemas/RiskScoreBlocklistTemporaryRule"},"bin":{"description":"Bank Identification Number (BIN) of the payment card for the charge.","$ref":"#/components/schemas/RiskScoreBlocklistTemporaryRule"},"country":{"description":"Country where the customer is making the purchase, and country of the payment card billing address.","$ref":"#/components/schemas/RiskScoreBlocklistTemporaryRule"},"customerId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rebilly "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the customer making the purchase."},"children":[]}]}]}],"$ref":"#/components/schemas/RiskScoreBlocklistTemporaryRule"},"email":{"description":"Email address of the customer making the purchase.","$ref":"#/components/schemas/RiskScoreBlocklistTemporaryRule"},"emailDomain":{"description":"Email address domain of the customer making the purchase.","$ref":"#/components/schemas/RiskScoreBlocklistTemporaryRule"},"fingerprint":{"description":"Fingerprint of the user's device.\nA device fingerprint is a unique token that is used to identify the user.\nThe device fingerprint is generated based on device attributes,\nsuch as: hardware, software, IP address, language, browser, and more.","$ref":"#/components/schemas/RiskScoreBlocklistTemporaryRule"},"ipAddress":{"description":"IP address of the customer making the purchase.","$ref":"#/components/schemas/RiskScoreBlocklistTemporaryRule"},"paymentCard":{"description":"Payment card number for the charge.","$ref":"#/components/schemas/RiskScoreBlocklistTemporaryRule"}}}},"components/schemas/RiskScoreBlocklist":{"id":"components/schemas/RiskScoreBlocklist","kind":"json-schema","title":"RiskScoreBlocklist","data":{"type":"object","description":"Risk score blocklist configuration.","properties":{"permanentlyBlockList":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items permanently blocklisted when TTL is equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/RiskScoreBlocklistPermanentRules"},"temporaryBlockList":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items temporarily blocklisted when TTL is greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/RiskScoreBlocklistTemporaryRules"}}}},"components/schemas/Allowlist":{"id":"components/schemas/Allowlist","kind":"json-schema","title":"Allowlist","data":{"type":"object","description":"Risk score allowlist record.","required":["type","value"],"properties":{"id":{"type":"string","description":"ID of the allowlist record.","readOnly":true,"maxLength":50,"example":"rsal_01HXBY67D5CNWM2YK79PFZR4C2"},"type":{"type":"string","description":"Type of data to exclude from risk score checks.\nData types that are added to this field are excluded from risk score checks and are not added to blocklists.","enum":["address","bank-account","bin","country","customer-id","email","email-domain","fingerprint","ip-address","payment-card"]},"value":{"type":"string","description":"Value of the allowlist record."},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/GlobalEventType":{"id":"components/schemas/GlobalEventType","kind":"json-schema","title":"GlobalEventType","data":{"type":"string","description":"Type of event.","enum":["aml-list-possibly-matched","application-instance-disabled","application-instance-enabled","autodeposit-lookup-performed","balance-transaction-settled","coupon-application-removed","coupon-applied","coupon-expiration-modified","coupon-expired","coupon-issued","coupon-modified","coupon-redeemed","coupon-redemption-canceled","credit-memo-applied","credit-memo-created","credit-memo-modified","credit-memo-partially-applied","credit-memo-voided","customer-created","customer-merged","customer-one-time-password-requested","customer-redirected-offsite","customer-returned","customer-tax-number-validated","customer-updated","data-export-completed","data-export-failed","dispute-created","dispute-modified","experian-check-performed","gateway-account-downtime-ended","gateway-account-downtime-started","gateway-account-limit-reached","gateway-account-onboarding-completed","gateway-account-onboarding-failed","gateway-account-requested","hard-usage-limit-reached","invoice-abandoned","invoice-created","invoice-issued","invoice-modified","invoice-paid","invoice-partially-paid","invoice-partially-refunded","invoice-past-due","invoice-past-due-reminder","invoice-refunded","invoice-reissued","invoice-tax-calculation-failed","invoice-voided","kyc-document-accepted","kyc-document-archived","kyc-document-created","kyc-document-modified","kyc-document-rejected","kyc-document-reviewed","kyc-request-attempted","kyc-request-failed","kyc-request-fulfilled","kyc-request-partially-fulfilled","lead-source-changed","offsite-payment-completed","order-abandon-reminder","order-abandoned","order-completed","order-delinquency-reached","organization-tax-number-validated","payment-card-created","payment-card-expiration-reminder","payment-card-expired","payment-instrument-modified","payout-request-canceled","payout-request-created","payout-request-fulfilled","payout-request-modified","quote-accepted","quote-canceled","quote-created","quote-expired","quote-issued","quote-recalled","quote-rejected","quote-updated","ready-to-pay-requested","renewal-invoice-issued","renewal-invoice-payment-canceled","renewal-invoice-payment-declined","risk-score-changed","soft-usage-limit-reached","subscription-activated","subscription-canceled","subscription-churned","subscription-created","subscription-downgraded","subscription-items-changed","subscription-modified","subscription-pause-created","subscription-pause-modified","subscription-pause-revoked","subscription-paused","subscription-quantity-filled-limit-reached","subscription-reactivated","subscription-renewal-reminder","subscription-renewed","subscription-resumed","subscription-trial-converted","subscription-trial-end-reminder","subscription-trial-ended","subscription-upgraded","transaction-amount-discrepancy-found","transaction-declined","transaction-discrepancy-found","transaction-process-requested","transaction-processed","transaction-reconciled","transaction-partially-refunded","transaction-refunded","transaction-timeout-resolved","transaction-voided","trial-usage-limit-reached","waiting-gateway-transaction-completed"]}},"components/schemas/TagUntagRule":{"id":"components/schemas/TagUntagRule","kind":"json-schema","title":"TagUntagRule","data":{"type":"object","description":"Tag or untag rule.","required":["name","eventType","addTags","removeTags"],"properties":{"id":{"type":"string","description":"ID of the rule.","readOnly":true,"maxLength":50,"example":"tag_rule_0YVCEE5APAD7V84MK3P9CCJVYY"},"name":{"description":"Name of the rule.","type":"string"},"eventType":{"allOf":[{"$ref":"#/components/schemas/GlobalEventType"},{"not":{"enum":["application-instance-disabled","application-instance-enabled","balance-transaction-settled","credit-memo-applied","credit-memo-created","credit-memo-modified","credit-memo-partially-applied","credit-memo-voided","customer-redirected-offsite","customer-returned","dispute-created","dispute-modified","gateway-account-downtime-ended","gateway-account-downtime-started","gateway-account-limit-reached","gateway-account-onboarding-completed","gateway-account-onboarding-failed","gateway-account-requested","invoice-created","invoice-modified","invoice-past-due-reminder","invoice-tax-calculation-failed","offsite-payment-completed","order-abandon-reminder","organization-tax-number-validated","payment-card-created","payment-card-expiration-reminder","payment-instrument-modified","renewal-invoice-payment-canceled","risk-score-changed","subscription-items-changed","subscription-modified","subscription-pause-created","subscription-pause-modified","subscription-pause-revoked","subscription-renewal-reminder","subscription-trial-converted","subscription-trial-end-changed","subscription-trial-end-reminder","subscription-trial-ended","transaction-process-requested","transaction-reconciled","transaction-timeout-resolved","waiting-gateway-transaction-completed","data-export-completed","data-export-failed","hard-usage-limit-reached","soft-usage-limit-reached","subscription-quantity-filled-limit-reached"]}}]},"filter":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter that determines whether to tag or untag."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field requires a special format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for multiple allowed values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for multiple fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api-reference.rebilly.com/#section/Using-filter-with-collections"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"]},"addTags":{"description":"List of tags to add to the customer.","type":"array","minItems":0,"maxItems":1000,"items":{"type":"string"}},"removeTags":{"description":"List of tags to remove for the customer.","type":"array","minItems":0,"maxItems":1000,"items":{"type":"string"}},"status":{"description":"Status of the rule.","type":"string","default":"active","enum":["active","inactive"]},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related resource links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self"]}}}}}}},"components/schemas/Organization":{"id":"components/schemas/Organization","kind":"json-schema","title":"Organization","data":{"type":"object","required":["name","country"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique organization identifier."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An organization is an entity that represents a company."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain an organization ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"readOnly":true,"maxLength":50,"example":"org_0YVDM8RC7GDADADSBSMW124JA8"},"name":{"description":"Name of the organization.","type":"string","maxLength":60,"x-sortable":true},"website":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Website URL of the organization."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value must begin with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"http://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","maxLength":65,"writeOnly":true,"format":"uri","example":"https://example.com"},"address":{"description":"Street address of the organization.","type":["string","null"],"maxLength":60,"x-sortable":true},"address2":{"description":"Second line of the street address.","type":["string","null"],"maxLength":60,"x-sortable":true},"city":{"description":"City where the organization is located.","type":["string","null"],"maxLength":45,"x-sortable":true},"region":{"description":"Region or state where the organization is located.","type":["string","null"],"maxLength":45,"x-sortable":true},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country where the organization is located, in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/obp/ui/#search/code/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Alpha-2 code format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":["string","null"],"pattern":"^[A-Z]{2}$","x-sortable":true},"postalCode":{"description":"Postal code of the organization.","type":"string","maxLength":10,"x-sortable":true},"phoneNumbers":{"$ref":"#/components/schemas/ContactPhoneNumbers"},"emails":{"$ref":"#/components/schemas/ContactEmails"},"taxDescriptor":{"description":"Tax label of the organization.\nThis information is displayed on the invoice.","type":["string","null"],"maxLength":255},"invoiceTimeZone":{"description":"Specifies the time zone to display on an invoice.\nUTC is used by default.","type":"string","maxLength":50,"example":"America/New_York"},"reportCurrency":{"description":"Currency to use for conversion in reports.\nThis value cannot be changed.","type":"string","pattern":"^[A-Z]{3}$","example":"USD"},"questionnaire":{"type":["object","null"],"description":"Organization questionnaire.","properties":{"role":{"type":["string","null"],"description":"Role of the owner."},"monthlyTransactions":{"type":["string","null"],"description":"Amount of monthly processed transactions."},"products":{"type":["array","null"],"description":"List of products the organization is interested in.","items":{"type":"string"}},"integrationType":{"type":["string","null"],"description":"Type of integration the organization would like."},"launchTiming":{"type":["string","null"],"description":"When the organization would like to go live."}}},"settings":{"type":"object","description":"Organization settings.","properties":{"defaultTaxCalculator":{"type":"object","description":"Tax calculation settings.","required":["type"],"properties":{"type":{"type":"string","description":"Type of tax calculator.","enum":["taxjar","avalara","flat"]},"rate":{"type":["number","null"],"format":"float","description":"Rate for flat tax calculation."}}},"billing":{"description":"Global organization settings for billing.","type":["object","null"],"properties":{"pendingOrderTtl":{"description":"Length of time, in ISO-8601 durations format, before which a pending order is automatically abandoned.","type":["string","null"],"example":"P7D","default":null},"orderDelinquencyPeriod":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length of time, in ISO-8601 durations format,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which is added to the due time of the order when setting the delinquency time for all related invoices."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the delinquency time of an invoice is reached, the order is automatically canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delinquencyPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the order does not change state and remains active."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must explicitly configure the delinquency period to enable automatic cancellation of unpaid orders."},"children":[]}]}]}]}],"type":["string","null"],"example":"P7D","default":null},"subtractRecurringDiscountsFromMrr":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether recurring discounts with a specified end date or usage limit are subtracted from order MRR in metrics calculations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", recurring discounts are excluded from order MRR."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Recurring discounts with no specified end date and usage limit are automatically subtracted from order MRR."},"children":[]}]}]}]}],"type":"boolean","default":false,"example":true},"subtractOneTimeDiscountsFromMrr":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether one-time discounts are subtracted from order MRR in metrics calculation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", one-time discounts are excluded from order MRR."},"children":[]}]}]}],"type":"boolean","default":false,"example":true}}},"taxLocations":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional organization addresses where a merchant may want to collect taxes using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxjar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tax calculator."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only for US-based organizations."},"children":[]}]}]}],"items":{"type":"object","required":["country"],"properties":{"address":{"description":"Street address of the tax location.","type":["string","null"],"maxLength":60},"city":{"description":"City of the tax location.","type":["string","null"],"maxLength":45},"region":{"description":"Region or state of the tax location.","type":["string","null"],"maxLength":45},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country of the tax location, in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/obp/ui/#search/code/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO Alpha-2 code format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","pattern":"^[A-Z]{2}$"},"postalCode":{"description":"Postal code of the tax location.","type":["string","null"],"maxLength":10}}}},"notifications":{"description":"Organization access-related notification settings.","type":"object","properties":{"notifyOnUserAccessChanges":{"description":"Specifies whether to send notifications when users are created or updated.","type":"boolean","default":false},"notifyOnApiKeyAccessChanges":{"description":"Specifies whether to send notifications when API keys are created or updated.","type":"boolean","default":false},"notificationEmailAddresses":{"description":"List of email addresses to send notifications to.","type":"array","items":{"type":"string","format":"email"},"default":[]}}},"annualComplianceScreening":{"description":"Settings for annual compliance screening of all active customers.\nWhen enabled, a compliance screening report is generated for every active customer\non the configured month and day each year.","type":"object","properties":{"enabled":{"description":"Specifies whether annual compliance screening is enabled for the organization.","type":"boolean","default":false},"monthDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Month and day when annual compliance screening runs, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid calendar date only. Leap day "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"02-29"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not allowed."},"children":[]}]}]}],"type":["string","null"],"pattern":"^(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$","example":"02-15","default":null}}},"payoutRequestAllocationOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default order for auto-allocation of payout requests."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set, this value is used when a payout request batch does not specify its own allocation order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order defines which payment instruments are attempted first during auto-allocation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selected-payment-instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exactly once."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment-card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (payment cards), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alternative-payment-methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (catch-all for alternative payment methods), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selected-payment-instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (customer-requested instrument), or any payment method API name (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paypal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Interac-eTransfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":["array","null"],"items":{"type":"string"},"minItems":2,"maxItems":25,"uniqueItems":true,"example":["payment-card","alternative-payment-methods","selected-payment-instrument"]}}},"taxNumbers":{"type":["array","null"],"description":"Tax numbers of the organization.","items":{"$ref":"#/components/schemas/TaxNumber"}},"features":{"type":"array","description":"Organization features.","readOnly":true,"items":{"type":"object","properties":{"name":{"description":"Name of the feature.","type":"string"},"description":{"description":"Description of the feature.","type":"string"}}}},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","attachments"]}}}}}}},"components/schemas/CheckoutFormId":{"id":"components/schemas/CheckoutFormId","kind":"json-schema","title":"CheckoutFormId","data":{"type":"string","description":"ID of the checkout form.","readOnly":true,"maxLength":50,"example":"chkt_frm_0YV8XZ6174C2MBS5011SAZNMBP"}},"components/schemas/CheckoutFormFixedPlan":{"id":"components/schemas/CheckoutFormFixedPlan","kind":"json-schema","title":"Fixed quantity","data":{"title":"Fixed quantity","type":"object","required":["planId","type","quantity"],"properties":{"planId":{"type":"string","description":"ID of the plan.","maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of plan. If this value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customers cannot choose the plan quantity."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"variable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customers can choose the plan quantity."},"children":[]}]}]}],"type":"string","enum":["fixed"]},"quantity":{"description":"Quantity of the plan.","type":"integer","minimum":1}}}},"components/schemas/CheckoutFormVariablePlan":{"id":"components/schemas/CheckoutFormVariablePlan","kind":"json-schema","title":"Variable quantity","data":{"title":"Variable quantity","type":"object","required":["planId","type","quantity"],"properties":{"planId":{"type":"string","description":"ID of the plan.","maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of plan. If this value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"variable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customers can choose the plan quantity."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customers cannot choose the plan quantity."},"children":[]}]}]}],"type":"string","enum":["variable"]},"quantity":{"description":"Default plan quantity.","type":"integer"},"minimum":{"description":"Minimum plan quantity.","type":"integer","minimum":1,"default":1},"multipleOf":{"description":"Multiple by which the plan quantity increases.","type":"integer","minimum":1,"default":1},"maximum":{"description":"Maximum plan quantity.","type":"integer","minimum":1,"default":100}}}},"components/schemas/CheckoutFormPlan":{"id":"components/schemas/CheckoutFormPlan","kind":"json-schema","title":"CheckoutFormPlan","data":{"type":"object","discriminator":{"propertyName":"type","mapping":{"fixed":"#/components/schemas/CheckoutFormFixedPlan","variable":"#/components/schemas/CheckoutFormVariablePlan"}},"oneOf":[{"$ref":"#/components/schemas/CheckoutFormFixedPlan"},{"$ref":"#/components/schemas/CheckoutFormVariablePlan"}]}},"components/schemas/CheckoutForm":{"id":"components/schemas/CheckoutForm","kind":"json-schema","title":"CheckoutForm","data":{"type":"object","required":["name","websiteId","plans"],"properties":{"id":{"type":"string","description":"ID of the checkout form.","readOnly":true,"maxLength":50,"example":"chkt_frm_0YV8XZ6174C2MBS5011SAZNMBP"},"websiteId":{"$ref":"#/components/schemas/WebsiteId"},"customDomain":{"description":"Custom domain for the checkout form.","type":["string","null"],"maxLength":255},"plans":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of plans that are applied to a customer order by default."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plans describe how the customer must pay for products. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/dev-docs/api/plans/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minItems":1,"items":{"$ref":"#/components/schemas/CheckoutFormPlan"}},"addonPlans":{"type":"array","description":"List of add-on plans that are displayed to the customer on the payment screen.\nAdd-ons are plans that the customer has not already subscribed to.\n\nThe customer selects whether to add an add-on plan to their current order.","default":[],"items":{"$ref":"#/components/schemas/CheckoutFormPlan"}},"bumpPlans":{"type":"array","description":"List of bump plans that are displayed to the customer on the payment screen.\nUse bump plans to offer purchase bonuses, discounts, and deals to the customer.\n\nThe customer selects whether to purchase bump plans,\nor to use the plans that are specified in their current order.","default":[],"items":{"$ref":"#/components/schemas/CheckoutFormPlan"}},"accountsEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if the account is enabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the customer can sign-up and sign-in using the checkout form."},"children":[]}]}]}],"type":"boolean","default":false},"couponsEnabled":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if coupons are enabled in the checkout form."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the customer can use coupons in the checkout form."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use coupons to reward customers, generate sales, or to test new pricing strategies."},"children":[]}]}]}],"type":"boolean","default":false},"purchaseLimit":{"description":"Limits the number of purchases that can be made using a specific checkout form.\nIf a purchase limit value is set, each purchase decreases this value.\nWhen the purchases limit value reaches zero, the checkout form becomes inactive.","type":["integer","null"],"minimum":0,"default":null},"paymentMethods":{"description":"List of available payment methods.\nPayment methods must have at least one active gateway account.\nIf not specified, all available payment methods are displayed.","type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"customization":{"description":"Visual customization options for the checkout form.","type":"object","properties":{"logoId":{"description":"ID of the linked file object.","type":["string","null"],"maxLength":50,"example":"file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"},"summary":{"description":"Summary text.","type":["string","null"]},"buttonText":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Button text."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{amount}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" placeholder to display the checkout form total."},"children":[]}]}]}],"type":"string","default":"Pay {{amount}}"},"colors":{"description":"Primary color used in the checkout form and button text.","type":"object","properties":{"primary":{"description":"Primary color for the checkout form in hexadecimal format.","type":"string","maxLength":6,"default":"0044d4"},"buttonText":{"description":"Button text color for the checkout form in hexadecimal format.","type":"string","maxLength":6,"default":"ffffff"}}},"links":{"description":"URLs that are displayed on the checkout form.","type":"object","properties":{"refundPolicy":{"description":"Website refund policy URL.","type":["string","null"],"format":"uri"},"privacyPolicy":{"description":"Website privacy policy URL.","type":["string","null"],"format":"uri"},"termsOfService":{"description":"Website terms of service URL.","type":["string","null"],"format":"uri"}}},"tracking":{"description":"Tracking system IDs.","type":"object","properties":{"googleAnalytics":{"description":"Google Analytics tracking ID.","type":["string","null"],"example":"UA-XXXXX-YY"},"googleTagManager":{"description":"Google Tag Manager tracking ID.","type":["string","null"],"example":"GTM-XXXXX"},"gtagJs":{"description":"Google Analytics tracking ID.\nThis value is used by Google Global Site Tag (gtag.js) service.","type":["string","null"],"example":"UA-XXXXX-YY"},"facebookPixel":{"description":"Facebook Pixel tracking ID.","type":["string","null"],"example":"1234567890"},"segmentAnalytics":{"description":"Segment Analytics tracking ID.","type":["string","null"],"example":"1234567890"},"heapIo":{"description":"Heap.io tracking ID.","type":["string","null"],"example":"1234567890"}}},"requiredAdditionalFields":{"description":"List of required fields.","type":"array","items":{"type":"string"},"example":["information.companyName","information.phoneNumber"]}}},"name":{"description":"Name of the checkout form.\nThis name value is for internal display, and is not visible to your customers.\nUse this name to locate and organize your checkout forms.","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the checkout form. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the checkout form URL produces a 404 error."},"children":[]}]}]}],"type":"string","enum":["active","inactive"],"default":"active"},"createdTime":{"$ref":"#/components/schemas/CreatedTime"},"updatedTime":{"$ref":"#/components/schemas/UpdatedTime"},"_links":{"type":"array","description":"Related links.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"Link URL.","type":"string"},"rel":{"description":"Type of link.","type":"string","enum":["self","preview"]}}}}}}},"schema_781":{"kind":"json-schema","data":{"type":"integer","minimum":0,"maximum":1000},"id":"schema_781"},"schema_782":{"kind":"json-schema","data":{"type":"string"},"id":"schema_782"},"schema_783":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_783"},"schema_784":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}},"id":"schema_784"},"schema_785":{"kind":"json-schema","data":{"type":"object","properties":{"Pagination-Total":{"type":"integer","description":"Total number of items.","example":332},"Pagination-Limit":{"type":"integer","description":"Maximum number of items per page.","example":100},"Pagination-Offset":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the starting point within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"collection of resource results. For example, a request with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit=20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" retrieves and displays the first 20 results on a page. A"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"following request with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit=20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset=20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", retrieves the next"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"page of 20 results."},"children":[]}]}]}],"example":2}}},"id":"schema_785"},"schema_786":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","format":"uri","description":"Location of the related resource.","example":"https://api.rebilly.com/example"},"X-RateLimit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of rate limit tokens for this request within a rate limit period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Rate-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":3600},"X-RateLimit-Remaining":{"type":"integer","description":"Remaining number of rate limit tokens for this request within the rate limit period. \nFor example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.","example":3600}}},"id":"schema_786"},"schema_787":{"kind":"json-schema","data":{"type":"object","properties":{"X-RateLimit-Retry-After":{"type":"integer","description":"UTC timestamp after which the rate limit resets and the request can be retried.","example":1713187500}}},"id":"schema_787"},"schema_788":{"kind":"json-schema","data":{"type":"string","maxLength":50,"pattern":"^[@~\\-\\.\\w]+$"},"id":"schema_788"},"schema_789":{"kind":"json-schema","data":{"type":"object","properties":{"X-RateLimit-Limit":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of rate limit tokens for this request within a rate limit period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Rate-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":3600},"X-RateLimit-Remaining":{"type":"integer","description":"Remaining number of rate limit tokens for this request within the rate limit period. \nFor example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.","example":3600}}},"id":"schema_789"},"schema_790":{"kind":"json-schema","data":{"properties":{"customerId":{"$ref":"#/components/schemas/CustomerId"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["aml-list-possibly-matched","customer-created","customer-merged","customer-one-time-password-requested","customer-redirected-offsite","customer-returned","customer-updated"]},"_embedded":{"type":"object","description":"Embedded objects related to the customer event.","properties":{"customer":{"$ref":"#/components/schemas/Customer"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["customer"]}}}}}},"id":"schema_790"},"schema_791":{"kind":"json-schema","data":{"properties":{"targetCustomerId":{"description":"ID of the customer that contains the merged data.","type":"string","maxLength":50,"example":"cus_0YV7DDSDD1C8DA64KHH2W33CPF"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["customer-merged"]},"duplicatedCustomer":{"$ref":"#/components/schemas/Customer"},"_embedded":{"type":"object","description":"Embedded objects related to the customer merge event.","properties":{"targetCustomer":{"$ref":"#/components/schemas/Customer"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["customer"]}}}}}},"id":"schema_791"},"schema_792":{"kind":"json-schema","data":{"properties":{"customerId":{"$ref":"#/components/schemas/CustomerId"},"taxIdNumber":{"type":"string","description":"Value of the tax number.","example":"GB980780684"},"taxIdType":{"type":"string","description":"Type of the tax ID number.","enum":["eu-vat","other"]},"isValid":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines if the tax number passed the EU official "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://ec.europa.eu/taxation_customs/vies/#/vat-validation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIES validation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"eventType":{"description":"Type of event that triggered the webhook.","type":"string","enum":["customer-tax-number-validated"]},"_embedded":{"type":"object","description":"Embedded objects related to the customer tax number validation event.","properties":{"customer":{"$ref":"#/components/schemas/Customer"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["customer"]}}}}}},"id":"schema_792"},"schema_793":{"kind":"json-schema","data":{"properties":{"customerId":{"$ref":"#/components/schemas/CustomerId"},"outcome":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check decision where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - record matches, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - no matches found, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - record mismatches."},"children":[]}]}]}],"type":"integer","enum":[-1,0,1],"example":1},"reason":{"description":"Text representation of the outcome.","type":"string","example":"Individual has a 90 percent or greater match to forename surname premise postcode with ID verified and DOB"},"errorCode":{"description":"Error code produced by the Experian system.","type":"string","example":"001"},"errorMessage":{"description":"Error message produced by the Experian system.","type":"string","example":"Authentication Error: Bad Username or Password"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["experian-check-performed"]},"_embedded":{"type":"object","description":"Embedded objects related to the Experian check event.","properties":{"customer":{"$ref":"#/components/schemas/Customer"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["customer"]}}}}}},"id":"schema_793"},"schema_794":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AuthenticationTokenResponse"}},"id":"schema_794"},"schema_795":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerCredential"}},"id":"schema_795"},"schema_796":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ResetPasswordToken"}},"id":"schema_796"},"schema_797":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AccountRegistrationSettings"}},"id":"schema_797"},"schema_798":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"id":"schema_798"},"schema_799":{"kind":"json-schema","data":{"type":"string","pattern":"^[@~\\-\\.\\w\\s+]+$"},"id":"schema_799"},"schema_800":{"kind":"json-schema","data":{"required":["name"],"properties":{"name":{"description":"Unique name for the tag.\nTag names are not case-sensitive.","type":"string","maxLength":255,"pattern":"^[@~\\-\\.\\w\\s+]+$","example":"New"}}},"id":"schema_800"},"schema_801":{"kind":"json-schema","data":{"type":"object","required":["customerIds"],"properties":{"customerIds":{"description":"List of customer IDs.","type":"array","minItems":1,"maxItems":1000,"items":{"type":"string"}}}},"id":"schema_801"},"schema_802":{"kind":"json-schema","data":{"type":"object","required":["kycDocumentIds"],"properties":{"kycDocumentIds":{"description":"List of KYC document IDs.","type":"array","minItems":1,"maxItems":1000,"items":{"type":"string","example":"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"}}}},"id":"schema_802"},"schema_803":{"kind":"json-schema","data":{"type":"object","required":["amlCheckIds"],"properties":{"amlCheckIds":{"description":"List of AML check IDs to tag.","type":"array","minItems":1,"maxItems":1000,"items":{"type":"string","example":"aml_chk_0YV8XJT2ZWDR398Q8NFEM7DEPM"}}}},"id":"schema_803"},"schema_804":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/TagUntagRule"}},"id":"schema_804"},"schema_805":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerTimelineCustomEvent"}},"id":"schema_805"},"schema_806":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerTimeline"}},"id":"schema_806"},"schema_807":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentInstrument"}},"id":"schema_807"},"schema_808":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/PaymentInstrumentCreateToken"},{"$ref":"#/components/schemas/PaymentCardCreatePlain"},{"$ref":"#/components/schemas/BankAccountCreatePlain"},{"$ref":"#/components/schemas/PayPalAccount"},{"$ref":"#/components/schemas/AlternativeInstrument"}]},"id":"schema_808"},"schema_809":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/PaymentInstrumentUpdateToken"},{"$ref":"#/components/schemas/PaymentCardUpdatePlain"},{"$ref":"#/components/schemas/BankAccountUpdatePlain"}]},"id":"schema_809"},"schema_810":{"kind":"json-schema","data":{"properties":{"paymentCardId":{"description":"ID of the payment instrument.","type":"string"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["payment-card-created","payment-card-expiration-reminder","payment-card-expired"]},"_embedded":{"type":"object","description":"Embedded objects related to the payment card event.","properties":{"paymentCard":{"$ref":"#/components/schemas/PaymentCard"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["paymentCard"]}}}}}},"id":"schema_810"},"schema_811":{"kind":"json-schema","data":{"properties":{"paymentInstrumentId":{"type":"string","description":"ID of the payment instrument.","maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["payment-instrument-modified"]},"_embedded":{"type":"object","description":"Embedded objects related to the payment instrument event.","properties":{"paymentInstrument":{"$ref":"#/components/schemas/PaymentInstrument"}}},"_links":{"type":"array","description":"Links to related resources.","readOnly":true,"items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["paymentInstrument"]}}}}}},"id":"schema_811"},"schema_812":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CompositeToken"}},"id":"schema_812"},"schema_813":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ReadyToPayMethods"}},"id":"schema_813"},"schema_814":{"kind":"json-schema","data":{"required":["type","websiteId","customerId","currency","amount"],"type":"object","properties":{"upsertCustomer":{"type":"boolean","default":false,"writeOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether to create or update (upsert) a customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the operation creates or updates (upserts) a customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" already exists, and the related customer is not updated."},"children":[]}]}]}]},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field supports a limited subset of transaction types."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To refund or void, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/transactions/posttransactionrefund"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund a transaction"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If any existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions are eligible,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"they are captured and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" converts to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"setup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type sets up the payment instrument by following the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"setupInstruction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the selected gateway account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the instruction is to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"do-nothing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a transaction with result "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"setup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns."},"children":[]}]}]}],"type":"string","enum":["sale","authorize","setup"]},"limits":{"$ref":"#/components/schemas/TransactionLimitAmount"},"websiteId":{"$ref":"#/components/schemas/WebsiteId"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"description":"Amount of the transaction.","type":"number","format":"double","example":97.97},"invoiceIds":{"description":"Array of invoice IDs.","type":["array","null"],"items":{"$ref":"#/components/schemas/ResourceId"}},"paymentInstruction":{"description":"Payment instruction for the purchase.\nIf this value is not supplied,\nthe customer's default payment instrument is used.","$ref":"#/components/schemas/PaymentInstruction"},"billingAddress":{"description":"Billing address.\nIf this value is not supplied,\nthe billing address associated with the payment instrument is used.\nIf no billing address is associated with the payment instrument,\nthe customer's billing address is used.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"requestId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to prevent duplicate transaction requests that may occur within a short period of time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a duplicate request is sent with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it is ignored to prevent double-billing."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value must be unique within a 24-hour period."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field is recommended."},"children":[]}]}]}]}],"type":["string","null"],"maxLength":50,"pattern":"^[\\-\\w]+$","example":"44433322-2c4y-483z-a0a9-158621f77a21"},"gatewayAccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the gateway account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rebilly selects the payment gateway account for the transaction based on transaction properties and the rules configuration of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gateway-account-requested"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To prevent Rebilly from making the gateway account selection,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supply a gateway account ID in this field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only use this field if you intend to override the settings."},"children":[]}]}]}],"type":["string","null"],"maxLength":50,"example":"gw_acc_0YVCXMF26DDNKAERE5NW727S34"},"description":{"type":["string","null"],"description":"Payment description.","maxLength":255},"notificationUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where a server-to-server "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notification is sent."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This notification is sent when the transaction result is finalized after a timeout or an offsite interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not interpret this notification as a confirmation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complete a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to confirm the result of the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure the request is not reattempted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when the result is confirmed, respond with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following placeholders are available to use in this URI: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{result}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These placeholders are replaced the with the transaction ID and result accordingly."},"children":[]}]}]}],"type":["string","null"],"maxLength":2083,"format":"uri"},"redirectUrl":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to redirect the end-user when an offsite transaction is completed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to the configured URL of the website."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You may use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{result}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as placeholders in the URL,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"these are replaced the with the transaction ID and result accordingly."},"children":[]}]}]}],"maxLength":2083,"format":"uri"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"riskMetadata":{"$ref":"#/components/schemas/RiskMetadata"},"isProcessedOutside":{"description":"Specifies when the transaction is processed outside Rebilly.","type":"boolean","default":false},"isMerchantInitiated":{"description":"Specifies when the transaction is initiated by the merchant.","type":"boolean","default":false},"processedTime":{"type":"string","description":"Time the transaction is processed.\nThis field is only specified if the transaction is processed outside Rebilly.","format":"date-time"}}},"id":"schema_814"},"schema_815":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"}},"id":"schema_815"},"schema_816":{"kind":"json-schema","data":{"type":"string","enum":["application/json","application/pdf"],"default":"application/json"},"id":"schema_816"},"schema_817":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_817"},"schema_818":{"kind":"json-schema","data":{"type":"object","title":"Patch transaction request","properties":{"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"}}},"id":"schema_818"},"schema_819":{"kind":"json-schema","data":{"type":"object","required":["websiteId","customerId","currency","amount"],"properties":{"websiteId":{"$ref":"#/components/schemas/WebsiteId"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"description":"Amount of the transaction.","type":"number","format":"double","example":97.97},"invoiceIds":{"description":"Array of invoice IDs.","type":["array","null"],"items":{"$ref":"#/components/schemas/ResourceId"}},"paymentInstruction":{"description":"Payment instruction for the purchase.\nIf this value is not supplied,\nthe customer's default payment instrument is used.","$ref":"#/components/schemas/PaymentInstruction"},"billingAddress":{"description":"Billing address.\nIf this value is not supplied,\nthe billing address associated with the payment instrument is used.\nIf no billing address is associated with the payment instrument,\nthe customer's billing address is used.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"requestId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to prevent duplicate transaction requests that may occur within a short period of time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a duplicate request is sent with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it is ignored to prevent double-billing."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value must be unique within a 24-hour period."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field is recommended."},"children":[]}]}]}]}],"type":["string","null"],"maxLength":50,"pattern":"^[\\-\\w]+$","example":"44433322-2c4y-483z-a0a9-158621f77a21"},"gatewayAccountId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the gateway account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rebilly selects the payment gateway account for the transaction based on transaction properties and the rules configuration of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gateway-account-requested"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To prevent Rebilly from making the gateway account selection,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supply a gateway account ID in this field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only use this field if you intend to override the settings."},"children":[]}]}]}],"type":["string","null"],"maxLength":50,"example":"gw_acc_0YVCXMF26DDNKAERE5NW727S34"},"description":{"type":["string","null"],"description":"Payment description.","maxLength":255},"notificationUrl":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where a server-to-server "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notification is sent."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This notification is sent when the transaction result is finalized after a timeout or an offsite interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not interpret this notification as a confirmation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complete a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to confirm the result of the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure the request is not reattempted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when the result is confirmed, respond with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following placeholders are available to use in this URI: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{result}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These placeholders are replaced the with the transaction ID and result accordingly."},"children":[]}]}]}],"type":["string","null"],"maxLength":2083,"format":"uri"},"redirectUrl":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to redirect the end-user when an offsite transaction is completed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to the configured URL of the website."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You may use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{result}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as placeholders in the URL,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"these are replaced the with the transaction ID and result accordingly."},"children":[]}]}]}],"maxLength":2083,"format":"uri"},"customFields":{"$ref":"#/components/schemas/ResourceCustomFields"},"riskMetadata":{"$ref":"#/components/schemas/RiskMetadata"},"isProcessedOutside":{"description":"Specifies when the transaction is processed outside Rebilly.","type":"boolean","default":false},"isMerchantInitiated":{"description":"Specifies when the transaction is initiated by the merchant.","type":"boolean","default":false},"processedTime":{"type":"string","description":"Time the transaction is processed.\nThis field is only specified if the transaction is processed outside Rebilly.","format":"date-time"},"payoutRequestId":{"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the payout request for which the transaction is fully allocated."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use the payout request allocation flow instead of this field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an allocation with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /payout-request-allocations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then initiate processing with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /payout-request-allocations/process"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"writeOnly":true,"type":"string","maxLength":50}}},"id":"schema_819"},"schema_820":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PayoutRequest"}},"id":"schema_820"},"schema_821":{"kind":"json-schema","data":{"type":"object","title":"Patch payout request","properties":{"status":{"description":"Status of the request.","type":"string","enum":["pending","ready","approved","canceled"],"x-enumDescriptions":{"pending":"Request was created by the customer.","ready":"Request was assessed, deemed eligible for processing and is ready for approval.","approved":"Request was approved and is ready for processing.","canceled":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request is canceled. This status requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceledBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}},"canceledBy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiator of the cancellation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","enum":["customer","merchant","system"]},"cancellationDescription":{"description":"Description of the cancellation reason.","type":["string","null"],"maxLength":255},"description":{"description":"Description of the payout request.","type":["string","null"]},"blocked":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the payout request is blocked or unblocked."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field can only be applied to payout requests in the following statuses:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in-progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a payout request is blocked, it cannot:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transition to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in-progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"split"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Have allocations created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start allocation processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel pending allocations."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A blocked payout request can still transition to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fulfilled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status if allocation processing starts before the payout request is blocked."},"children":[]}]}]}],"type":"boolean","example":false},"blockReason":{"oneOf":[{"$ref":"#/components/schemas/PayoutRequestBlockReason"},{"type":"null"}]},"blockDescription":{"description":"Additional description for blocking the payout request.","type":["string","null"],"maxLength":255}}},"id":"schema_821"},"schema_822":{"kind":"json-schema","data":{"type":"array","description":"List of available payment instruments per an associated gateway to offer for the payout.","items":{"type":"object","properties":{"paymentInstrumentId":{"type":"string","description":"ID of the payment instrument to offer for the payout.","maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"},"gatewayName":{"description":"Name of the payment gateway and payment instrument to use for the payout.\nThis field is empty if the requested payment instrument has not been used yet.","x-label":"Gateway account","x-basic":true,"type":["string","null"],"allOf":[{"$ref":"#/components/schemas/GatewayName"}]},"gatewayAccountId":{"description":"ID of the gateway account to use for processing this allocation.","type":"string","maxLength":50,"example":"gateway_0YVB8KPKNXCBR9EDX7JHSED75N"},"gatewayPayoutInstruction":{"description":"Payout configuration for the gateway account.","type":["string","null"],"enum":["all","covered-payout","approved-payment","none",null],"example":"covered-payout"},"exposureAmount":{"description":"Total amount of sales minus credit for the specified gateway and instrument.","type":"number","format":"double"},"previousAllocatedAmount":{"description":"Total amount of allocated credit for the payout request for the specified gateway and instrument.","type":"number","format":"double"},"lastPaymentTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time when the last payment is created for the gateway and the payment instrument."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments are the result of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions."},"children":[]}]}]}],"type":["string","null"],"format":"date-time"},"lastPayoutTime":{"description":"Date and time when the last payout is created for the gateway and the payment instrument.","type":["string","null"],"format":"date-time"}}}},"id":"schema_822"},"schema_823":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PayoutRequestAllocation"}},"id":"schema_823"},"schema_824":{"kind":"json-schema","data":{"type":"object","properties":{"payoutRequestId":{"type":"string","description":"ID of the payout request to allocate.","maxLength":50,"example":"pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"},"paymentInstrumentId":{"type":"string","description":"ID of the payment instrument to allocate.","maxLength":50,"example":"inst_0YVB8KPKNXCBR9EDX7JHSED75N"},"gatewayAccountId":{"type":"string","description":"ID of the gateway account.","maxLength":50,"example":"gw_acc_0YVCXMF26DDNKAERE5NW727S34"},"amount":{"type":"number","format":"double","description":"Amount to allocate to this payment instrument.","x-type":"Money"}},"required":["payoutRequestId","paymentInstrumentId","gatewayAccountId","amount"]},"id":"schema_824"},"schema_825":{"kind":"json-schema","data":{"type":"object","properties":{"payoutRequestId":{"type":"string","description":"ID of the payout request to allocate.","maxLength":50,"example":"pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"}},"required":["payoutRequestId"]},"id":"schema_825"},"schema_826":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New status for the allocation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to move an allocation from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which begins payment processing."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to stop the allocation before it is processed."},"children":[]}]}]}],"enum":["processing","canceled"],"example":"processing"}},"required":["status"]},"id":"schema_826"},"schema_827":{"kind":"json-schema","data":{"type":"object","required":["allocationIds"],"properties":{"allocationIds":{"description":"Array of allocation IDs to process.","type":"array","minItems":1,"maxItems":1000,"items":{"type":"string","maxLength":50,"example":"pra_0YVDMDE2BMC6KBB5MX76RF6T80"}}}},"id":"schema_827"},"schema_828":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PayoutRequestBatch"}},"id":"schema_828"},"schema_829":{"kind":"json-schema","data":{"type":"object","oneOf":[{"title":"Explicit IDs","required":["payoutRequestIds"],"properties":{"payoutRequestIds":{"description":"Array of payout request IDs to include in the batch.","type":"array","minItems":1,"maxItems":1000,"items":{"type":"string","maxLength":50,"example":"pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"}},"description":{"description":"Optional description of the batch.","type":["string","null"],"maxLength":255,"example":"Batch processed on 2024-01-15"}}},{"title":"Filter-based","required":["filter"],"properties":{"filter":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter string that is used to select payout requests."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field uses the same format as collection filter parameters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use semicolons to separate multiple filter conditions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available filter fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"websiteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter is provided, it is ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout requests that are already included in a batch are always excluded from the results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If more than 1000 payout requests match the filter, only the oldest 1000 are included in the batch, sorted by creation time."},"children":[]}]}]}],"type":"string","example":"status:pending;websiteId:ws_0YVDMDE2BMC6KBB5MX76RF6T80"},"description":{"description":"Optional description of the batch.","type":["string","null"],"maxLength":255,"example":"Pending payout requests batch - 2024-01-15"}}}]},"id":"schema_829"},"schema_830":{"kind":"json-schema","data":{"type":"object","title":"Patch payout request batch","properties":{"description":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of the batch."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit this property when not updating the description."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; use a string value when this property is present."},"children":[]}]}]}],"type":"string","maxLength":255},"allocationOrder":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order for auto-allocation of payout requests in this batch."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set, this field overrides the organization-level allocation order during batch auto-allocation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selected-payment-instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exactly once."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment-card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (payment cards), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alternative-payment-methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (catch-all for alternative payment methods), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selected-payment-instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (customer-requested instrument), or any payment method API name (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paypal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Interac-eTransfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit this property when not updating the allocation order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; use an array value when this property is present."},"children":[]}]}]}],"type":"array","items":{"type":"string"},"minItems":2,"maxItems":25,"uniqueItems":true,"example":["paypal","Interac-eTransfer","payment-card","alternative-payment-methods","selected-payment-instrument"]}}},"id":"schema_830"},"schema_831":{"kind":"json-schema","data":{"type":"object","required":["reason"],"properties":{"reason":{"$ref":"#/components/schemas/PayoutRequestBlockReason"},"description":{"description":"Additional description for blocking the payout requests in the batch.","type":["string","null"],"maxLength":255}}},"id":"schema_831"},"schema_832":{"kind":"json-schema","data":{"type":"object","oneOf":[{"title":"Explicit IDs","additionalProperties":false,"required":["payoutRequestIds"],"properties":{"payoutRequestIds":{"description":"IDs of the payout requests to add to the batch.","type":"array","minItems":1,"maxItems":1000,"uniqueItems":true,"items":{"type":"string","maxLength":50,"example":"pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"}}}},{"title":"Filter-based","additionalProperties":false,"required":["filter"],"properties":{"filter":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter string that selects payout requests to add to the batch."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field uses the same format as filter parameters for collections."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use semicolons to separate multiple filter conditions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available fields for filtering: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"websiteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation ignores a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter results always exclude payout requests that are already associated with a batch."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the filter matches more payout requests than the batch can contain,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the operation adds only the oldest matching requests up to the batch limit,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sorted by creation time."},"children":[]}]}]}],"type":"string","minLength":1,"example":"status:pending;websiteId:ws_0YVDMDE2BMC6KBB5MX76RF6T80"}}}]},"id":"schema_832"},"schema_833":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["payoutRequestIds"],"properties":{"payoutRequestIds":{"description":"IDs of the payout requests to remove from the batch.","type":"array","minItems":1,"maxItems":1000,"uniqueItems":true,"items":{"type":"string","maxLength":50,"example":"pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"}}}},"id":"schema_833"},"schema_834":{"kind":"json-schema","data":{"type":"string","example":"status:pending;websiteId:ws_0YVDMDE2BMC6KBB5MX76RF6T80"},"id":"schema_834"},"schema_835":{"kind":"json-schema","data":{"type":"object","properties":{"matchingCount":{"description":"Total number of matching payout requests, regardless of the preview limit.","type":"integer","minimum":0,"example":42},"customerCount":{"description":"Number of unique customers in the matching payout requests.","type":"integer","minimum":0,"example":3},"totalAmountByCurrency":{"description":"Total amount grouped by currency for matching payout requests.","type":"array","items":{"type":"object","required":["currency","amount"],"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"type":"number"}}}}}},"id":"schema_835"},"schema_836":{"kind":"json-schema","data":{"properties":{"transactionId":{"$ref":"#/components/schemas/TransactionId"},"redirectUrl":{"description":"URL customer redirected to.","type":"string","format":"uri"},"ipAddress":{"description":"Customer's IP address.","type":"string"},"httpHeaders":{"description":"Customer's browser HTTP headers.","type":"object","additionalProperties":{"type":"string"},"example":{"Content-Type":"application/json","Accept":"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"}},"eventType":{"description":"Type of event that triggered the webhook.","type":"string","enum":["customer-redirected-offsite","customer-returned"]},"_embedded":{"type":"object","description":"Embedded objects related to the customer redirect event.","properties":{"transaction":{"$ref":"#/components/schemas/Transaction"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["transaction"]}}}}}},"id":"schema_836"},"schema_837":{"kind":"json-schema","data":{"properties":{"transactionId":{"$ref":"#/components/schemas/TransactionId"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["gateway-account-requested","offsite-payment-completed","risk-score-changed","transaction-amount-discrepancy-found","transaction-declined","transaction-discrepancy-found","transaction-process-requested","transaction-processed","transaction-reconciled","transaction-timeout-resolved","waiting-gateway-transaction-completed","autodeposit-lookup-performed"]},"_embedded":{"type":"object","description":"Embedded objects related to the transaction event.","properties":{"transaction":{"$ref":"#/components/schemas/Transaction"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["transaction"]}}}}}},"id":"schema_837"},"schema_838":{"kind":"json-schema","data":{"properties":{"payoutRequestId":{"description":"ID of the payout request.","type":"string"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["payout-request-created","payout-request-modified","payout-request-canceled","payout-request-fulfilled"]},"_embedded":{"type":"object","description":"Embedded objects related to the payout request event.","properties":{"payoutRequest":{"$ref":"#/components/schemas/PayoutRequest"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["payoutRequest"]}}}}}},"id":"schema_838"},"schema_839":{"kind":"json-schema","data":{"properties":{"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["ready-to-pay-requested"]},"websiteId":{"$ref":"#/components/schemas/WebsiteId"},"currency":{"type":"string","description":"Currency of the ready to pay request."},"amount":{"type":"number","format":"double","description":"Amount of the ready to pay request."},"items":{"type":"array","items":{"type":"object","required":["planId","quantity"],"properties":{"planId":{"type":"string","description":"ID of the plan.","maxLength":50,"example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"},"quantity":{"description":"Number of product units in the specified plan.","type":"integer"}}}},"billingAddress":{"description":"Customer's billing address.","oneOf":[{"$ref":"#/components/schemas/ContactObject"},{"type":"null"}]},"riskMetadata":{"$ref":"#/components/schemas/RiskMetadata"},"customerId":{"$ref":"#/components/schemas/CustomerId"},"transactionId":{"$ref":"#/components/schemas/TransactionId"},"checkoutFormId":{"$ref":"#/components/schemas/CheckoutFormId"},"_embedded":{"type":"object","description":"Embedded objects related to the ready to pay event.","properties":{"checkoutForm":{"$ref":"#/components/schemas/CheckoutForm"},"customer":{"$ref":"#/components/schemas/Customer"},"transaction":{"$ref":"#/components/schemas/Transaction"},"website":{"$ref":"#/components/schemas/Website"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["checkoutForm","customer","transaction","website"]}}}}}},"id":"schema_839"},"schema_840":{"kind":"json-schema","data":{"properties":{"transactionId":{"$ref":"#/components/schemas/TransactionId"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["transaction-partially-refunded","transaction-refunded","transaction-voided"]},"_embedded":{"type":"object","description":"Embedded objects related to the transaction event.","properties":{"transaction":{"$ref":"#/components/schemas/Transaction"},"childTransaction":{"$ref":"#/components/schemas/Transaction"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["transaction","childTransaction"]}}}}}},"id":"schema_840"},"schema_841":{"kind":"json-schema","data":{"properties":{"customerId":{"$ref":"#/components/schemas/CustomerId"},"transactionId":{"$ref":"#/components/schemas/TransactionId"},"autodepositLookupResponse":{"description":"Autodeposit lookup response.","type":"object","properties":{"enrolled":{"type":"boolean","default":false,"description":"Specifies whether the autodeposit lookup is enrolled or not."},"firstName":{"type":["string","null"],"description":"First name from the autodeposit lookup response."},"lastName":{"type":["string","null"],"description":"Last name from the autodeposit lookup response."},"middleName":{"type":["string","null"],"description":"Middle name from the autodeposit lookup response."},"companyName":{"type":["string","null"],"description":"Company name from the autodeposit lookup response."},"tradeName":{"type":["string","null"],"description":"Trade name from the autodeposit lookup response."}}},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["autodeposit-lookup-performed"]},"_embedded":{"type":"object","description":"Embedded objects related to the autodeposit lookup event.","properties":{"customer":{"$ref":"#/components/schemas/Customer"},"transaction":{"$ref":"#/components/schemas/Transaction"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["customer","transaction"]}}}}}},"id":"schema_841"},"schema_842":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Dispute"}},"id":"schema_842"},"schema_843":{"kind":"json-schema","data":{"type":"object","required":["currency","amount","transactionId","postedTime","type","status","reasonCode"],"properties":{"transactionId":{"description":"ID of the disputed transaction.","$ref":"#/components/schemas/TransactionId"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"amount":{"description":"Dispute amount.","type":"number","format":"double"},"acquirerReferenceNumber":{"description":"Acquirer reference number for the dispute.","type":["string","null"],"maxLength":255},"caseId":{"description":"Case ID of the dispute.","type":["string","null"],"maxLength":100},"reasonCode":{"description":"Code used in the chargeback that describes the reason for the dispute.","type":"string","maxLength":255,"enum":["0","00","1","2","3","4","5","6","7","8","9","10.1","10.2","10.3","10.4","10.5","11.1","11.2","11.3","12","12.1","12.2","12.3","12.4","12.5","12.6","12.6.1","12.6.2","12.7","13.1","13.2","13.3","13.4","13.5","13.6","13.7","13.8","13.9","30","31","34","35","37","40","41","42","46","47","49","50","51","53","54","55","56","57","59","60","62","63","70","71","72","73","74","75","76","77","78","79","80","81","82","83","85","86","93","98","004","021","024","059","062","063","127","154","155","158","173","175","176","193","680","684","691","693","1000","2001","2002","2003","2004","2005","2008","2011","2700","2701","2702","2703","2704","2705","2706","2707","2708","2709","2710","2713","2870","2871","4807","4808","4812","4831","4834","4837","4840","4841","4842","4846","4849","4850","4853","4854","4855","4859","4860","4863","4870","4871","4901","4902","4903","4904","4905","4908","4999","4534","4541","4542","4550","4553","4586","4752","4753","4755","4865","4866","4867","7010","7030","8002","A","A01","A02","A08","AL","AP","AW","B","C","C02","C04","C05","C08","C14","C18","C28","C31","C32","CA","CD","CR","D","DA","DP","DP1","EX","F10","F14","F22","F24","F29","F30","F31","FR1","FR2","FR4","FR6","IC","IN","IS","ITA","LP","M01","M10","M49","N","NA","NC","P","P01","P03","P04","P05","P07","P08","P22","P23","R03","R13","RG","RM","RN1","RN2","SV","TF","TNM","UA01","UA02","UA03","UA10","UA11","UA12","UA18","UA20","UA21","UA22","UA23","UA28","UA30","UA31","UA32","UA38","UA99","bank_cannot_process","credit_not_processed","customer_initiated","debit_not_authorized","duplicate","fraudulent","general","incorrect_account_details","insufficient_funds","merchandise","non_receipt","not_as_described","pre-chargeback-alert","product_not_received","product_unacceptable","special","subscription_canceled","unauthorized","unauthorized_claim","unrecognized","MERCHANDISE_OR_SERVICE_NOT_RECEIVED","MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED","UNAUTHORISED","CREDIT_NOT_PROCESSED","DUPLICATE_TRANSACTION","INCORRECT_AMOUNT","PAYMENT_BY_OTHER_MEANS","CANCELED_RECURRING_BILLING","PROBLEM_WITH_REMITTANCE","OTHER"]},"type":{"description":"Type of dispute.","type":"string","enum":["information-request","first-chargeback","second-chargeback","arbitration","fraud","ethoca-alert","verifi-alert","bank-return","paypal-claim","representment","inquiry","forced-refund","collaboration"]},"status":{"description":"Status of the dispute.","type":"string","enum":["response-needed","under-review","forfeited","won","lost","unknown"]},"postedTime":{"description":"Date and time when the dispute is posted.","type":"string","format":"date-time"},"deadlineTime":{"description":"Latest date and time by when a merchant must submit a representment for a dispute.\nIf the deadline is missed, the merchant loses the dispute.","type":["string","null"],"format":"date-time"}}},"id":"schema_843"},"schema_844":{"kind":"json-schema","data":{"properties":{"disputeId":{"type":"string","description":"ID of the dispute.","maxLength":50,"example":"dp_0YVCE8J5F2DE58FV0S8YASW4HK"},"transactionId":{"type":["string","null"],"description":"ID of the transaction.","maxLength":50,"example":"txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["dispute-created","dispute-modified"]},"_embedded":{"type":"object","description":"Embedded objects related to the dispute event.","properties":{"dispute":{"$ref":"#/components/schemas/Dispute"},"transaction":{"oneOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"null"}]}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["dispute","transaction"]}}}}}},"id":"schema_844"},"schema_845":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Fee"}},"id":"schema_845"},"schema_846":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/TransactionTimeline"}},"id":"schema_846"},"schema_847":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PayoutRequestTimelineMessage"}},"id":"schema_847"},"schema_848":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionOrOneTimeSale"}},"id":"schema_848"},"schema_849":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","format":"uri","description":"Location of the related resource.","example":"https://api.rebilly.com/example"}}},"id":"schema_849"},"schema_850":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionPause"}},"id":"schema_850"},"schema_851":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionCancellation"}},"id":"schema_851"},"schema_852":{"kind":"json-schema","data":{"allOf":[{"properties":{"canceledBy":{"readOnly":true},"status":{"readOnly":true}}},{"$ref":"#/components/schemas/SubscriptionCancellation"}]},"id":"schema_852"},"schema_853":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionReactivation"}},"id":"schema_853"},"schema_854":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/UpcomingInvoice"}},"id":"schema_854"},"schema_855":{"kind":"json-schema","data":{"properties":{"subscriptionId":{"type":"string","description":"ID of the order.","example":"sub_01HRF27SATGE4Z6PBJE6PD8328"},"subscriptionItemId":{"type":"string","description":"ID of the subscription item.","example":"sub_01HW2V1Y3A6QPM1NX4WCYHFSRS"},"planId":{"type":"string","description":"ID of the plan.","example":"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"},"usageQuantity":{"type":"integer","description":"Reported usage quantity."},"usageAmount":{"type":"number","format":"double","description":"Reported usage amount."},"currency":{"type":"string","description":"Currency of the reported usage amount."},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["soft-usage-limit-reached","hard-usage-limit-reached","trial-usage-limit-reached"]},"_embedded":{"type":"object","description":"Embedded objects related to the usage limit event.","properties":{"subscription":{"$ref":"#/components/schemas/SubscriptionOrOneTimeSale"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["subscription"]}}}}}},"id":"schema_855"},"schema_856":{"kind":"json-schema","data":{"properties":{"subscriptionId":{"type":"string","description":"ID of the order.","example":"sub_01HRF27SATGE4Z6PBJE6PD8328"},"scheduleNumber":{"type":"integer","description":"Number of triggered abandon reminder events."},"eventType":{"description":"Type of event that triggered the webhook.","type":"string","enum":["order-abandon-reminder"]},"_embedded":{"type":"object","description":"Embedded objects related to the order abandon reminder event.","properties":{"subscription":{"$ref":"#/components/schemas/SubscriptionOrOneTimeSale"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["subscription"]}}}}}},"id":"schema_856"},"schema_857":{"kind":"json-schema","data":{"properties":{"subscriptionId":{"type":"string","description":"ID of the order.","example":"sub_01HRF27SATGE4Z6PBJE6PD8328"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["order-completed","order-abandoned","subscription-activated","subscription-canceled","subscription-churned","subscription-downgraded","subscription-modified","subscription-reactivated","subscription-renewal-reminder","subscription-renewed","subscription-trial-converted","subscription-trial-end-changed","subscription-trial-end-reminder","subscription-trial-ended","subscription-upgraded","order-delinquency-reached","subscription-items-changed"]},"_embedded":{"type":"object","description":"Embedded objects related to the order event.","properties":{"subscription":{"$ref":"#/components/schemas/SubscriptionOrOneTimeSale"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["subscription"]}}}}}},"id":"schema_857"},"schema_858":{"kind":"json-schema","data":{"properties":{"subscriptionId":{"type":"string","description":"ID of the order.","example":"sub_01HRF27SATGE4Z6PBJE6PD8328"},"invoiceId":{"type":"string","description":"ID of the invoice.","maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["renewal-invoice-issued"]},"_embedded":{"type":"object","description":"Embedded objects related to the renewal invoice event.","properties":{"subscription":{"$ref":"#/components/schemas/SubscriptionOrOneTimeSale"},"invoice":{"$ref":"#/components/schemas/Invoice"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["subscription","invoice"]}}}}}},"id":"schema_858"},"schema_859":{"kind":"json-schema","data":{"properties":{"subscriptionId":{"type":"string","description":"ID of the order.","example":"sub_01HRF27SATGE4Z6PBJE6PD8328"},"subscriptionItemId":{"type":"string","description":"ID of the subscription item.","example":"sub_01HW2V1Y3A6QPM1NX4WCYHFSRS"},"quantity":{"type":"integer","description":"Quantity of the subscription item."},"quantityFilled":{"type":"number","format":"double","example":5.125,"description":"Reported quantity."},"previousQuantityFilled":{"type":"number","format":"double","example":4.037,"description":"Reported quantity before the subscription item updates."},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["subscription-quantity-filled-limit-reached"]},"_embedded":{"type":"object","description":"Embedded objects related to the subscription quantity limit event.","properties":{"subscription":{"$ref":"#/components/schemas/SubscriptionOrOneTimeSale"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["subscription"]}}}}}},"id":"schema_859"},"schema_860":{"kind":"json-schema","data":{"properties":{"subscriptionId":{"type":"string","description":"ID of the order.","example":"sub_01HRF27SATGE4Z6PBJE6PD8328"},"subscriptionPauseId":{"type":"string","description":"ID of the subscription pause.","example":"sub_pau_01H085J3ZR1WKD120D73D7N4C9"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["subscription-pause-created","subscription-pause-modified","subscription-pause-revoked","subscription-paused","subscription-resumed"]},"_embedded":{"type":"object","description":"Embedded objects related to the subscription pause event.","properties":{"subscription":{"$ref":"#/components/schemas/SubscriptionOrOneTimeSale"},"pause":{"$ref":"#/components/schemas/SubscriptionPause"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["subscription","pause"]}}}}}},"id":"schema_860"},"schema_861":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}},"id":"schema_861"},"schema_862":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItem"}},"id":"schema_862"},"schema_863":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceTransactionAllocation"}},"id":"schema_863"},"schema_864":{"kind":"json-schema","data":{"properties":{"invoiceId":{"type":"string","description":"ID of the invoice.","maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"reason":{"description":"Error message explaining tax calculation failure.","type":"string"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["invoice-tax-calculation-failed"]},"_embedded":{"type":"object","description":"Embedded objects related to the invoice tax calculation event.","properties":{"invoice":{"$ref":"#/components/schemas/Invoice"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["invoice"]}}}}}},"id":"schema_864"},"schema_865":{"kind":"json-schema","data":{"properties":{"invoiceId":{"type":"string","description":"ID of the invoice.","maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["invoice-abandoned","invoice-created","invoice-issued","invoice-modified","invoice-paid","invoice-partially-paid","invoice-partially-refunded","invoice-past-due","invoice-past-due-reminder","invoice-refunded","invoice-reissued","invoice-tax-calculation-failed","invoice-voided"]},"_embedded":{"type":"object","description":"Available embedded objects that are requested by the expand query parameter.","properties":{"invoice":{"$ref":"#/components/schemas/Invoice"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["invoice"]}}}}}},"id":"schema_865"},"schema_866":{"kind":"json-schema","data":{"properties":{"transactionId":{"$ref":"#/components/schemas/TransactionId"},"invoiceId":{"type":"string","description":"ID of the invoice.","maxLength":50,"example":"in_0YVF9605RKC62BP14NE2R7V2XT"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["renewal-invoice-payment-canceled","renewal-invoice-payment-declined"]},"_embedded":{"type":"object","description":"Embedded objects related to the invoice and transaction event.","properties":{"transaction":{"$ref":"#/components/schemas/Transaction"},"invoice":{"$ref":"#/components/schemas/Invoice"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["transaction","invoice"]}}}}}},"id":"schema_866"},"schema_867":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Usage"}},"id":"schema_867"},"schema_868":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CreditMemo"}},"id":"schema_868"},"schema_869":{"kind":"json-schema","data":{"properties":{"creditMemoId":{"type":"string","description":"ID of the credit memo.","maxLength":50,"example":"crmm_0YVCNN22TWC3G8H82QNPNVZCHG"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["credit-memo-applied","credit-memo-created","credit-memo-modified","credit-memo-partially-applied","credit-memo-voided"]},"_embedded":{"type":"object","description":"Embedded objects related to the credit memo event.","properties":{"creditMemo":{"$ref":"#/components/schemas/CreditMemo"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["creditMemo"]}}}}}},"id":"schema_869"},"schema_870":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Plan"}},"id":"schema_870"},"schema_871":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"id":"schema_871"},"schema_872":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CouponRedemption"}},"id":"schema_872"},"schema_873":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Coupon"}},"id":"schema_873"},"schema_874":{"kind":"json-schema","data":{"properties":{"couponId":{"description":"ID of the coupon.","type":"string"},"redemptionId":{"description":"ID of the redemption.","type":"string"},"customerId":{"description":"ID of the customer.","type":"string"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["coupon-application-removed","coupon-applied","coupon-redeemed","coupon-redemption-canceled"]},"_embedded":{"type":"object","description":"Embedded objects related to the coupon redemption event.","properties":{"coupon":{"$ref":"#/components/schemas/Coupon"},"redemption":{"$ref":"#/components/schemas/CouponRedemption"},"customer":{"$ref":"#/components/schemas/Customer"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["coupon","redemption","customer"]}}}}}},"id":"schema_874"},"schema_875":{"kind":"json-schema","data":{"properties":{"couponId":{"description":"ID of the coupon.","type":"string"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["coupon-expiration-modified","coupon-expired","coupon-issued","coupon-modified"]},"_embedded":{"type":"object","description":"Embedded objects related to the coupon event.","properties":{"coupon":{"$ref":"#/components/schemas/Coupon"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["coupon"]}}}}}},"id":"schema_875"},"schema_876":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Quote"}},"id":"schema_876"},"schema_877":{"kind":"json-schema","data":{"properties":{"quoteId":{"type":"string","description":"ID of the quote.","example":"qt_01HXBZMEGPETPHJZH6V4RHBMA8"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["quote-accepted","quote-canceled","quote-created","quote-expired","quote-issued","quote-recalled","quote-rejected","quote-updated"]},"_embedded":{"type":"object","description":"Embedded objects related to the quote event.","properties":{"quote":{"$ref":"#/components/schemas/Quote"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["quote"]}}}}}},"id":"schema_877"},"schema_878":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/QuoteTimeline"}},"id":"schema_878"},"schema_879":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ShippingRate"}},"id":"schema_879"},"schema_880":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/OrderTimeline"}},"id":"schema_880"},"schema_881":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceTimeline"}},"id":"schema_881"},"schema_882":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CreditMemoTimeline"}},"id":"schema_882"},"schema_883":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Blocklist"}},"id":"schema_883"},"schema_884":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Allowlist"}},"id":"schema_884"},"schema_885":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/KycRequest"}},"id":"schema_885"},"schema_886":{"kind":"json-schema","data":{"allOf":[{"properties":{"customerId":{"readOnly":true}}},{"$ref":"#/components/schemas/KycRequest"}]},"id":"schema_886"},"schema_887":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/KycDocument"}},"id":"schema_887"},"schema_888":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/KycIdentityMatchesOverwrite"},{"$ref":"#/components/schemas/KycAddressMatchesOverwrite"},{"$ref":"#/components/schemas/KycPurchaseMatchesOverwrite"},{"$ref":"#/components/schemas/KycFundsMatchesOverwrite"}],"discriminator":{"propertyName":"type","mapping":{"identity-proof":"#/components/schemas/KycIdentityMatchesOverwrite","address-proof":"#/components/schemas/KycAddressMatchesOverwrite","purchase-proof":"#/components/schemas/KycPurchaseMatchesOverwrite","funds-proof":"#/components/schemas/KycFundsMatchesOverwrite"}}},"id":"schema_888"},"schema_889":{"kind":"json-schema","data":{"properties":{"customerId":{"$ref":"#/components/schemas/CustomerId"},"kycDocumentId":{"type":"string","description":"ID of the KYC document.","maxLength":50,"example":"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"},"fileId":{"type":"string","description":"ID of the file.","maxLength":50,"example":"file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["kyc-document-accepted","kyc-document-created","kyc-document-modified","kyc-document-rejected","kyc-document-reviewed","kyc-document-archived"]},"_embedded":{"type":"object","description":"Embedded objects related to the KYC document event.","properties":{"customer":{"$ref":"#/components/schemas/Customer"},"kycDocument":{"$ref":"#/components/schemas/KycDocument"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["customer","file","kycDocument"]}}}}}},"id":"schema_889"},"schema_890":{"kind":"json-schema","data":{"properties":{"customerId":{"$ref":"#/components/schemas/CustomerId"},"kycRequestId":{"type":"string","description":"ID of the KYC request.","maxLength":50,"example":"kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5"},"eventType":{"type":"string","description":"Type of event that triggered the webhook.","enum":["kyc-request-attempted","kyc-request-failed","kyc-request-fulfilled","kyc-request-partially-fulfilled"]},"_embedded":{"type":"object","description":"Embedded objects related to the KYC request event.","properties":{"customer":{"$ref":"#/components/schemas/Customer"},"kycRequest":{"$ref":"#/components/schemas/KycRequest"}}},"_links":{"type":"array","description":"Links to related resources.","items":{"type":"object","properties":{"href":{"description":"URL of the link.","type":"string"},"rel":{"description":"Relationship type of the link.","type":"string","enum":["customer","kycRequest"]}}}}}},"id":"schema_890"},"schema_891":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AmlCheck"}},"id":"schema_891"},"schema_892":{"kind":"json-schema","data":{"type":"string","enum":["customers","payment-instruments","orders","subscriptions","transactions","websites","products","plans","gateway-accounts","deposit-requests"]},"id":"schema_892"},"schema_893":{"kind":"json-schema","data":{"description":"List of custom fields.","type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"id":"schema_893"},"schema_894":{"kind":"json-schema","data":{"type":"string","maxLength":60,"pattern":"^[\\w-]+$"},"id":"schema_894"},"schema_895":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}},"id":"schema_895"},"schema_896":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/File"}},"id":"schema_896"},"schema_897":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/FileCreateFromInline"},{"$ref":"#/components/schemas/FileCreateFromUrl"}]},"id":"schema_897"},"schema_898":{"kind":"json-schema","data":{"type":"string","example":"700x700","pattern":"^[1-9]{1}[0-9]{1,3}x[1-9]{1}[0-9]{1,3}$"},"id":"schema_898"},"schema_899":{"kind":"json-schema","data":{"type":"string","readOnly":true,"format":"binary"},"id":"schema_899"},"schema_900":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Length":{"type":"integer","description":"Number of bytes in the file.","example":48},"Content-Type":{"type":"string","description":"MIME type of the file.","example":"image/png"}}},"id":"schema_900"},"schema_901":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","format":"uri","example":"https://api.rebilly.com/example"}}},"id":"schema_901"},"schema_902":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Search"}},"id":"schema_902"}},"exampleStore":{"components/examples/stripe-trx-request":{"id":"components/examples/stripe-trx-request","value":{"type":"buy","name":"Stripe transaction fees","filter":"type:sale,capture;result:approved;gatewayAccountId:stripe","formula":{"type":"fixed-fee","currency":"USD","amount":0.3}},"summary":"Stripe transaction fees","description":"Transaction fees for Stripe.\nDiscount rate fees are a separate record."},"components/examples/stripe-us-request":{"id":"components/examples/stripe-us-request","value":{"type":"buy","name":"Stripe US fees","filter":"type:sale,capture;result:approved;billingAddress.country:US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":290}},"summary":"Stripe US fees","description":"Fees for Stripe in the US.\nFees for outside of the US are a different fee record."},"components/examples/stripe-intl-request":{"id":"components/examples/stripe-intl-request","value":{"type":"buy","name":"Stripe international fees","filter":"type:sale,capture;result:approved;billingAddress.country:!US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":390}},"summary":"Stripe international fees","description":"Fees for Stripe outside of the US."},"components/examples/stripe-trx-response":{"id":"components/examples/stripe-trx-response","value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe transaction fees","filter":"type:sale,capture;result:approved;gatewayAccountId:stripe","formula":{"type":"fixed-fee","currency":"USD","amount":0.3},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"summary":"Stripe transaction fees","description":"Stripe transaction fees.\nDiscount rate fees are a separate record."},"components/examples/stripe-us-response":{"id":"components/examples/stripe-us-response","value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe US fees","filter":"type:sale,capture;result:approved;billingAddress.country:US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":290},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"summary":"Stripe US fees","description":"Stripe transaction fees for the US.\nFees for outside of the US are a different fee record."},"components/examples/stripe-intl-response":{"id":"components/examples/stripe-intl-response","value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe international fees","filter":"type:sale,capture;result:approved;billingAddress.country:!US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":390},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"summary":"Stripe international fees","description":"Stripe transaction fees for outside of the US."},"paths/~1fees/post/requestBody/content/application~1json/examples/stripe-trx":{"value":{"type":"buy","name":"Stripe transaction fees","filter":"type:sale,capture;result:approved;gatewayAccountId:stripe","formula":{"type":"fixed-fee","currency":"USD","amount":0.3}},"key":"stripe-trx","summary":"Stripe transaction fees","description":"Transaction fees for Stripe.\nDiscount rate fees are a separate record.","id":"paths/~1fees/post/requestBody/content/application~1json/examples/stripe-trx"},"paths/~1fees/post/requestBody/content/application~1json/examples/stripe-us":{"value":{"type":"buy","name":"Stripe US fees","filter":"type:sale,capture;result:approved;billingAddress.country:US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":290}},"key":"stripe-us","summary":"Stripe US fees","description":"Fees for Stripe in the US.\nFees for outside of the US are a different fee record.","id":"paths/~1fees/post/requestBody/content/application~1json/examples/stripe-us"},"paths/~1fees/post/requestBody/content/application~1json/examples/stripe-intl":{"value":{"type":"buy","name":"Stripe international fees","filter":"type:sale,capture;result:approved;billingAddress.country:!US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":390}},"key":"stripe-intl","summary":"Stripe international fees","description":"Fees for Stripe outside of the US.","id":"paths/~1fees/post/requestBody/content/application~1json/examples/stripe-intl"},"paths/~1fees/post/responses/201/content/application~1json/examples/stripe-trx":{"value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe transaction fees","filter":"type:sale,capture;result:approved;gatewayAccountId:stripe","formula":{"type":"fixed-fee","currency":"USD","amount":0.3},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"key":"stripe-trx","summary":"Stripe transaction fees","description":"Stripe transaction fees.\nDiscount rate fees are a separate record.","id":"paths/~1fees/post/responses/201/content/application~1json/examples/stripe-trx"},"paths/~1fees/post/responses/201/content/application~1json/examples/stripe-us":{"value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe US fees","filter":"type:sale,capture;result:approved;billingAddress.country:US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":290},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"key":"stripe-us","summary":"Stripe US fees","description":"Stripe transaction fees for the US.\nFees for outside of the US are a different fee record.","id":"paths/~1fees/post/responses/201/content/application~1json/examples/stripe-us"},"paths/~1fees/post/responses/201/content/application~1json/examples/stripe-intl":{"value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe international fees","filter":"type:sale,capture;result:approved;billingAddress.country:!US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":390},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"key":"stripe-intl","summary":"Stripe international fees","description":"Stripe transaction fees for outside of the US.","id":"paths/~1fees/post/responses/201/content/application~1json/examples/stripe-intl"},"paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-trx":{"value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe transaction fees","filter":"type:sale,capture;result:approved;gatewayAccountId:stripe","formula":{"type":"fixed-fee","currency":"USD","amount":0.3},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"key":"stripe-trx","summary":"Stripe transaction fees","description":"Stripe transaction fees.\nDiscount rate fees are a separate record.","id":"paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-trx"},"paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-us":{"value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe US fees","filter":"type:sale,capture;result:approved;billingAddress.country:US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":290},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"key":"stripe-us","summary":"Stripe US fees","description":"Stripe transaction fees for the US.\nFees for outside of the US are a different fee record.","id":"paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-us"},"paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-intl":{"value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe international fees","filter":"type:sale,capture;result:approved;billingAddress.country:!US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":390},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"key":"stripe-intl","summary":"Stripe international fees","description":"Stripe transaction fees for outside of the US.","id":"paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/stripe-intl"},"paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-trx":{"value":{"type":"buy","name":"Stripe transaction fees","filter":"type:sale,capture;result:approved;gatewayAccountId:stripe","formula":{"type":"fixed-fee","currency":"USD","amount":0.3}},"key":"stripe-trx","summary":"Stripe transaction fees","description":"Transaction fees for Stripe.\nDiscount rate fees are a separate record.","id":"paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-trx"},"paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-us":{"value":{"type":"buy","name":"Stripe US fees","filter":"type:sale,capture;result:approved;billingAddress.country:US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":290}},"key":"stripe-us","summary":"Stripe US fees","description":"Fees for Stripe in the US.\nFees for outside of the US are a different fee record.","id":"paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-us"},"paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-intl":{"value":{"type":"buy","name":"Stripe international fees","filter":"type:sale,capture;result:approved;billingAddress.country:!US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":390}},"key":"stripe-intl","summary":"Stripe international fees","description":"Fees for Stripe outside of the US.","id":"paths/~1fees~1{id}/put/requestBody/content/application~1json/examples/stripe-intl"},"paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-trx":{"value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe transaction fees","filter":"type:sale,capture;result:approved;gatewayAccountId:stripe","formula":{"type":"fixed-fee","currency":"USD","amount":0.3},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"key":"stripe-trx","summary":"Stripe transaction fees","description":"Stripe transaction fees.\nDiscount rate fees are a separate record.","id":"paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-trx"},"paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-us":{"value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe US fees","filter":"type:sale,capture;result:approved;billingAddress.country:US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":290},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"key":"stripe-us","summary":"Stripe US fees","description":"Stripe transaction fees for the US.\nFees for outside of the US are a different fee record.","id":"paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-us"},"paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-intl":{"value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe international fees","filter":"type:sale,capture;result:approved;billingAddress.country:!US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":390},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"key":"stripe-intl","summary":"Stripe international fees","description":"Stripe transaction fees for outside of the US.","id":"paths/~1fees~1{id}/put/responses/200/content/application~1json/examples/stripe-intl"},"paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-trx":{"value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe transaction fees","filter":"type:sale,capture;result:approved;gatewayAccountId:stripe","formula":{"type":"fixed-fee","currency":"USD","amount":0.3},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"key":"stripe-trx","summary":"Stripe transaction fees","description":"Stripe transaction fees.\nDiscount rate fees are a separate record.","id":"paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-trx"},"paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-us":{"value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe US fees","filter":"type:sale,capture;result:approved;billingAddress.country:US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":290},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"key":"stripe-us","summary":"Stripe US fees","description":"Stripe transaction fees for the US.\nFees for outside of the US are a different fee record.","id":"paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-us"},"paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-intl":{"value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe international fees","filter":"type:sale,capture;result:approved;billingAddress.country:!US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":390},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"key":"stripe-intl","summary":"Stripe international fees","description":"Stripe transaction fees for outside of the US.","id":"paths/~1fees~1{id}/put/responses/201/content/application~1json/examples/stripe-intl"},"paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-trx":{"value":{"type":"buy","name":"Stripe transaction fees","filter":"type:sale,capture;result:approved;gatewayAccountId:stripe","formula":{"type":"fixed-fee","currency":"USD","amount":0.3}},"key":"stripe-trx","summary":"Stripe transaction fees","description":"Transaction fees for Stripe.\nDiscount rate fees are a separate record.","id":"paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-trx"},"paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-us":{"value":{"type":"buy","name":"Stripe US fees","filter":"type:sale,capture;result:approved;billingAddress.country:US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":290}},"key":"stripe-us","summary":"Stripe US fees","description":"Fees for Stripe in the US.\nFees for outside of the US are a different fee record.","id":"paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-us"},"paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-intl":{"value":{"type":"buy","name":"Stripe international fees","filter":"type:sale,capture;result:approved;billingAddress.country:!US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":390}},"key":"stripe-intl","summary":"Stripe international fees","description":"Fees for Stripe outside of the US.","id":"paths/~1fees~1{id}/patch/requestBody/content/application~1json/examples/stripe-intl"},"paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-trx":{"value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe transaction fees","filter":"type:sale,capture;result:approved;gatewayAccountId:stripe","formula":{"type":"fixed-fee","currency":"USD","amount":0.3},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"key":"stripe-trx","summary":"Stripe transaction fees","description":"Stripe transaction fees.\nDiscount rate fees are a separate record.","id":"paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-trx"},"paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-us":{"value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe US fees","filter":"type:sale,capture;result:approved;billingAddress.country:US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":290},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"key":"stripe-us","summary":"Stripe US fees","description":"Stripe transaction fees for the US.\nFees for outside of the US are a different fee record.","id":"paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-us"},"paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-intl":{"value":{"id":"fee_01GQT145JX3XBRJ8K812Y3GRE9","type":"buy","name":"Stripe international fees","filter":"type:sale,capture;result:approved;billingAddress.country:!US;gatewayAccountId:stripe","formula":{"type":"percentage","currency":"USD","bips":390},"createdTime":"2021-12-15T14:15:22Z","updatedTime":"2021-12-15T14:15:22Z","_links":[{"rel":"self","href":"https://api-sandbox.rebilly.com/fees/fee_01GQT145JX3XBRJ8K812Y3GRE9"}]},"key":"stripe-intl","summary":"Stripe international fees","description":"Stripe transaction fees for outside of the US.","id":"paths/~1fees~1{id}/patch/responses/200/content/application~1json/examples/stripe-intl"},"paths/~1kyc-requests/post/requestBody/content/application~1json/examples/credit-file-identity-address":{"value":{"customerId":"123_456789","redirectUrl":"https://example.com/return-here/","documents":[{"type":"credit-file-proof","maxAttempts":1},{"type":"identity-proof"},{"type":"address-proof"}],"reason":"registration"},"key":"credit-file-identity-address","summary":"Credit file with fallback","id":"paths/~1kyc-requests/post/requestBody/content/application~1json/examples/credit-file-identity-address"},"paths/~1kyc-requests/post/requestBody/content/application~1json/examples/identity-with-face-proof":{"value":{"customerId":"123_456789","redirectUrl":"https://example.com/return-here/","documents":[{"type":"identity-proof","faceProofRequired":true,"faceLivenessRequired":false}],"reason":"registration"},"key":"identity-with-face-proof","summary":"Identity with face proof","id":"paths/~1kyc-requests/post/requestBody/content/application~1json/examples/identity-with-face-proof"},"paths/~1kyc-requests/post/requestBody/content/application~1json/examples/identity-and-address":{"value":{"customerId":"123_456789","redirectUrl":"https://example.com/return-here/","documents":[{"type":"identity-proof"},{"type":"address-proof"}],"reason":"registration"},"key":"identity-and-address","summary":"Identity and address","id":"paths/~1kyc-requests/post/requestBody/content/application~1json/examples/identity-and-address"}},"securitySchemeStore":{"JWT":{"id":"JWT","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT is a short lifetime token that can be assigned a specific expiration time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"ApplicationJWT":{"id":"ApplicationJWT","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/application-owners/getapplicationinstancebyorganization/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an application instance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"PublishableApiKey":{"id":"PublishableApiKey","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This authentication method is applicable to specific operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a publishable API key, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/api-keys/postapikey"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an API key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"in":"header","paramName":"Authorization"},"SecretApiKey":{"id":"SecretApiKey","type":"apiKey","description":"Never share your secret keys.\nKeep them guarded and secure.\n\nUse your secret API key only to make requests from the server side.\nTo authenticate, provide your secret key in the request header.","in":"header","paramName":"REB-APIKEY"},"CustomerJWT":{"id":"CustomerJWT","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a JSON Web Token (JWT) using Storefront authentication,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/catalog/all/storefront-account/storefrontpostlogin"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a session with username and password"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"servers":[{"url":"/_mock/docs/dev-docs/api","isMockServer":true,"description":"Mock server"},{"url":"https://api-sandbox.rebilly.com/organizations/{organizationId}","description":"Sandbox server","variables":{"organizationId":{"default":"{organizationId}","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique organization identifier."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An organization is an entity that represents a company."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain an organization ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},{"url":"https://api.rebilly.com/organizations/{organizationId}","description":"Live server","variables":{"organizationId":{"default":"{organizationId}","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique organization identifier."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An organization is an entity that represents a company."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain an organization ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}],"logo":{"imageUrl":"https://rebilly-core.redoc.ly/rb_apiLogo.svg","href":"https://www.rebilly.com/contact/","backgroundColor":"#0044d4"}},"options":{"feedback":{"type":"mood","settings":{"comment":{"satisfiedLabel":"What did you like about this page?"},"optionalEmail":{"hide":false},"label":"Was this section helpful?"}},"hideSidebar":true,"mockServer":{"url":"/_mock/docs/dev-docs/api","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/dev-docs/api/index.json?download"},{"url":"/_bundle/docs/dev-docs/api/index.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Core APIs","description":"The most common APIs used to automate common workflows.","redocly_category":"API Reference"}},"baseSlug":"/docs/dev-docs/api","routesMapping":{}}